Novassium API

Welcome to Proxyle's Novassium API documentation! This guide provides all the necessary information for developers, users, and resellers to integrate and interact with the Novassium Image Generation API. Whether you're looking to generate images programmatically or integrate the API into your applications, this documentation will help you get started and make the most out of the Novassium.

Table of Contents

1. Getting Started
2. Authentication
3. API Endpoint
4. Request Parameters
5. Response Structure
6. Error Handling
7. Rate Limiting
8. Regenerating API Keys
9. Testing with Postman
10. FAQs

Getting Started

The Novassium API documentation provides REST API endpoints that allow users, developers, and resellers to generate images based on various parameters. To start using the API, you'll need to:

1. Obtain an API Key: Each user with an active subscription to specific Novassium products will have a unique API key.
2. Set Up Your Environment: Use tools like Postman or integrate the API into your applications using your preferred programming language.
3. Make API Requests: Interact with the API endpoints to generate images as per your requirements.

Authentication

All API requests must be authenticated using an API Key. This key ensures that only authorized users with active subscriptions can access the API services.

How to Use the API Key

Include your API Key in the request headers using the X-API-Key field.

X-API-Key: your_unique_api_key_here
    

Note: Keep your API Key confidential. Do not share it publicly or expose it in client-side code.

API Endpoint

Generate Image

Endpoint:

POST https://proxyle.com/api/novassium/v1/generate

Description:

Generates images based on the provided parameters using the Novassium image generation service.

Request Parameters

All parameters must be sent in the request body as JSON.

Example Request Body

{
    "prompt": "The exterior of a beautiful royal mansion",
    "style_preset": "photographic",
    "aspect_ratio": "16:9",
    "samples": 1,
    "negative_prompt": "No buildings or humans",
    "seed": 123456789,
    "output_format": "png",
    "width": 1920,
    "height": 1080
}
    

Response Structure

Successful Response

When the image generation is successful, the API will respond with a 200 status code and return the URLs of the generated images along with the remaining credits.

Example:

{
    "success": true,
    "images": [
        "https://proxyle-media.s3.amazonaws.com/file/a-beautiful-royal-mansion3.png"
    ],
    "remaining_credits": 997
}
    

• success: Indicates the success status of the request.
• images: An array of URLs pointing to the generated images.
• remaining_credits: The number of API credits remaining for the user after the request.
• NOTE: If you are generating image via this API, you must set the sample as "1" as the API can generate one image per request.

Error Response

If there's an issue with the request, the API will respond with an appropriate HTTP status code and an error message.

Example:

{
    "success": false,
    "message": "Prompt is required."
}
    

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request. Below are the possible error responses:

Common Error Messages:

Missing API Key:

{
    "success": false,
    "message": "API key is missing."
}
    

Invalid API Key:

{
    "success": false,
    "message": "Invalid API key."
}
    

Prompt Required:

{
    "success": false,
    "message": "Prompt is required."
}
    

Invalid Image Dimensions:

{
    "success": false,
    "message": "Image dimensions must be between 64 and 16,384 pixels."
}
    

Rate Limit Exceeded:

{
    "success": false,
    "message": "Rate limit exceeded. Please try again later."
}
    

Rate Limiting

To ensure fair usage and maintain optimal performance, the Novassium API enforces rate limiting:

• Limit: 100 requests per hour per user; 2400 total requests per day per user
• Time Window: 1 hour; 24 hours.

If you exceed this limit, you'll receive a 429 Too Many Requests error. Please plan your API usage accordingly to stay within these limits.

Regenerating API Keys

If you suspect that your API Key has been compromised or simply wish to regenerate it, you can do so via your Novassium dashboard.

• Click the Regenerate API Key button.
• Confirm the action when prompted.

Important: Regenerating your API Key will revoke the existing one. Ensure you update all your integrations with the new key to avoid service interruptions.

Testing with Postman

Postman is a popular tool for testing APIs. Follow the steps below to test the Novassium API using Postman.

Step 1: Install Postman

If you haven't already, download and install Postman from the official website.

Step 2: Create a New Request

1. Open Postman.
2. Click on New > Request.
3. Name your request (e.g., "Generate Novassium Image") and choose a collection to save it in or create a new one.
4. Click Save.

Step 3: Configure the Request

Method and URL

• Method: POST
• URL: https://proxyle.com/api/novassium/v1/generate

Headers

Example:

Body

1. Select the Body tab.
2. Choose raw and set the format to JSON.
3. Enter the JSON payload with the necessary parameters.

Example:

{
    "prompt": "A yummy-looking chocolate cake",
    "style_preset": "digital-art",
    "aspect_ratio": "16:9",
    "samples": 1,
    "output_format": "jpeg",
    "width": 1920,
    "height": 1080
}
    

Step 4: Send the Request

1. Review your request to ensure all details are correct.
2. Click the Send button.
3. Observe the response in the Response section.

Step 5: Analyze the Response

• Success: You'll receive a JSON response with the generated image URLs and remaining credits.
• Error: If there's an issue, an error message with an appropriate HTTP status code will be returned.

Step 6: Save and Reuse the Request

1. Click Save after configuring your request.
2. Organize your requests into collections for better management.

FAQs

1. What products grant access to the Novassium API?

Access to the Novassium API is granted to users with an active subscription to any of the following products:

• Novice
• Creator
• Artist
• Ninja
• Ranger
• Titan

Please ensure your subscription is active to use the API services.

2. How are API credits managed?

Each image generation request consumes credits based on the number of samples requested. For example, requesting 3 samples will deduct 3 credits from your account. Ensure you have sufficient credits before making requests.

3. What should I do if I encounter a 500 Internal Server Error?

A 500 Internal Server Error indicates an unexpected issue on the server. Try the following steps:

• Check the API parameters for correctness.
• Ensure your API Key is valid and has the necessary permissions.
• Contact Proxyle support if the issue persists.

4. Can I modify the image dimensions beyond the specified limits?

No, the API enforces image dimensions between 64 and 16,384 pixels for both width and height. Additionally, the total pixel count must be at least 4,096 pixels. These limits ensure optimal performance and quality.

5. Is it possible to increase my rate limit?

Rate limits are in place to ensure fair usage and maintain service quality. If you need higher rate limits, please contact Proxyle support to discuss possible accommodations.

6. How do I ensure my API Key remains secure?

• Do not share your API Key publicly.
• Store your API Key securely in environment variables or secure storage solutions.
• Regularly monitor your API usage for any suspicious activity.
• Regenerate your API Key if you suspect it has been compromised.

7. I need to download Novassium WordPress plugin?

Sure! The Novassium WordPress plugin is available. Please download it here.

Thank you for choosing Novassium API! If you have any further questions or need assistance, please reach out to us: support@proxyle.com