Join our Discord

Support

RenderNet APIs

API Reference

Release Notes

Get Started

The generation estimate endpoint lets users estimate the number of credits required for a particular generation. With this endpoint, users can send a payload containing their preferred parameters. In return, they will receive the credit cost for processing the generation request and the current balance.

Estimate Generation

ID of the character. You can get the details of characters using `GET /pub/v1/characters` endpoint or else you can create one using `POST /pub/v1/characters`

Used for hyper-realistic face. Keep it false for stylized characters

Use 0.6-0.8 for creating images in the character’s style. Use 0.1-0.3 for creating images in a different style.

Upload a reference image using the `POST /pub/v1/assets/upload` endpoint . Pass the asset id in the payload to use the asset as a reference image for controlnet.

The priority of the control net: 
- `0` - The priority between control net and prompt is balanced. 
- `1` - The prompt priority is higher than the control net. 
- `2` - The control net priority is higher than the prompt.


Query the list resources endpoint `GET /pub/v1/controlnets`  to view all available controlnets. Make sure your Controlnet has the same base model (SD 1.5/SDXL) as your selected style/model.

The relation between the control net image and generated image: 
- `0` - Resize and Fill. 
- `1` - Crop and Resize. 
- `2` - Just Resize.

The estimated number of credits for the generation

Upload a reference image of a person using the `POST /pub/v1/assets/upload` endpoint. Pass the asset id in the payload to create AI characters with the same face as the reference image.

The aspect ratio of the image for the generation

The batch size of the generation (Max permissible value depends on your subscription plan). Visit [RenderNet pricing](https://app.rendernet.ai/pricing) for more details

AI guidance for this generation. Higher the value, the output will be closer to the prompt (but may result in distorted images after a point)

If you want to create images of a character, use the character’s name in the positive prompt. Example: {character_name} riding a bike

The control net(pose control) for the generation if you want to use (optional)

The face you want to restore for the generation if you want to use (optional)

Query the list resources endpoint `GET /pub/v1/loras` to view all available LoRAs. You can add multiple LoRAs to a single generation. Make sure your LoRAs have the same base model (SD 1.5 / SDXL) as your selected style/model.

Query the list models endpoint `GET /pub/v1/models` to view all available models.

For Narrator generation, pass either `script` or `audio_asset_id` along with other required details in `narrator` payload. 

The quality of the image for the generation (Case Sensitive)

The sampler you want to use for the generation (Case Sensitive)

The seed for the generation (randomized if you don't want to use a seed)

Changes the input asset image based on the find and replace prompts

The number of steps you want AI to take for the generation

Enhances and upscales the input image passed in the asset_id

Specify the strength of the LoRA being applied. Higher values will influence the generation more.

ID of an audio asset. You can get the details of available audio assets using `GET /pub/v2/assets?type=audio` endpoint or else you can upload one using `POST /pub/v2/assets/upload?type=audio`.

ID of an image asset for FaceSwap feature. Upload an image asset with a face clearly visible, preferably looking forward. You can get the details of available image assets using `GET /pub/v2/assets?type=image` endpoint or else you can upload one using `POST /pub/v2/assets/upload`.

Describe/share the script you want to hear in the video narration.

ID of a video asset. Uploaded video asset should have only one person with a clear view of their face. You can get the details of available video assets using `GET /pub/v2/assets?type=video` endpoint or else you can upload one using `POST /pub/v2/assets/upload?type=video`.

Query the list resources endpoint `GET /pub/v1/voices` to view all available voices, and use any one from it for narrator generation.

The positive prompt. If you are submitting a character for generation then make sure to pass the character's name in curly braces here. For ex. {Alex} on a trek

Upload an image using the upload asset endpoint `POST /pub/v1/assets/upload`

Describe an element in the image that you want to change. Specify only 1 element at a time (eg: black tshirt, red car, hair, etc).

Describe the element you want to see in the image instead (eg: a yellow tshirt, a white car, pink hair, etc).

Specify the level of realistic enhancement you want to apply to your image.

Specify how much you want to upscale the your image by.

Generation Estimate

Introduction

The generations endpoint lets users generate media based on various parameters such as aspect ratio, model, prompt etc. The response will return a generation ID for each request, which can be used to track the status and view generated media.

Generate Media

The list generations endpoint lets users retrieve information about all their generated media and their associated generation details. Users can filter by generation_id, media_id or status.

List Generations

The get generation endpoint lets users fetch the details for a generation using its id.

Get Generation

The get media endpoint lets users fetch the details for a particular generated media using its id.

Get Media

The generation status endpoint lets users check the status of a generation using its id.

Generation Status (Deprecating)

The image status endpoint lets users check the status of a specific image within a generation.

Image Status (Deprecating)

The delete generation endpoint lets the user delete a specific generation while retaining other generations.

Delete Generation

The delete image endpoint lets the user delete a specific image within a generation while retaining any other images that may have been generated in the same batch.

Delete Image (Deprecating)

The delete media endpoint lets the user delete a specific media within a generation while retaining any other media that may have been generated in the same batch.

Delete Media

The upload asset endpoint facilitates users in uploading assets to the platform. By providing the height and width of the image for image assets and an empty object `{}` for audio and video assets, users will receive an upload URL to which they can make a `PUT` request and attach the media to upload it. For more details click [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html). The uploaded asset will then be accessible at the URL received in the data object of the upload asset endpoint response.

Upload Asset V2

The get asset endpoint lets users retrieve detailed information about a specific asset, including its size, type, status, URL, duration (for video and audio asset) and frames(for video asset)

Get Asset V2

The list assets endpoint lets users retrieve detailed information about their uploaded assets, including its size, type, status, URL, duration (for video and audio asset) and frames (for video asset). This endpoint is paginated.

List Assets V2

The archive assets endpoint allows users to archive their uploaded assets. Users can send a list of asset ids to this endpoint to archive the associated assets.

Archive Asset V2

The upload asset endpoint facilitates users in uploading assets to the platform. By providing the height and width of the image, users will receive an upload URL to which they can make a `PUT` request and attach the image to upload it. For more details click [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html). The uploaded asset will then be accessible at the URL received in the data object of the upload asset endpoint response.

Upload Asset

The get asset endpoint lets users retrieve detailed information about a specific asset, including its size, type, status, tags, and URL.

Get Asset

The list assets endpoint lets users retrieve detailed information about their uploaded assets, including their dimensions, URL, status, tags, and type. This endpoint is paginated.

List Assets

Archive Asset

The get characters section allows users to fetch a list of all available characters along with their details.

Get Characters

The create character section enables users to create a character with a unique name, which can be used in prompts to generate consistent images containing the character. Users can provide the asset_id of a face image and create a character by assigning a description and unique name. This feature streamlines the process of adding new characters to the platform and managing them efficiently.

Create Character

The archive character section allows users to archive a character that they have created. Archiving a character will mean that the user can no longer create any images with that character.

Archive Character

The edit character section allows users to edit a character which has already been created

Edit Character

The list models endpoint lets users retrieve a list of available models. The response will return a paginated list of the specified all available models along with their names and base model (SD 1.5 or SDXL).



List Models

The list styles endpoint lets users retrieve a list of available styles. The response will return a paginated list of all available styles along with their names and base model (SD 1.5 or SDXL).



List Styles

The list loras endpoint lets users retrieve a list of available LoRAs. The response will return a paginated list of all available LoRAs along with their names and base model (SD 1.5 or SDXL).



List LoRAs

The list controlnets endpoint lets users retrieve a list of available ControlNets. The response will return a paginated list of all available ControlNets along with their names and base model (SD 1.5 or SDXL).



List ControlNets

The list voices endpoint lets users retrieve a list of available Voices that can be used for generating Lip Sync videos by providing script. The response will return a paginated list of all available Voices along with their details such as age, gender, accent, voice for demo etc.

API Documentation

Generations

Assets V2

Assets

Characters

Resources

Estimate Generation

Headers

Body

Response