Join our Discord

Support

RenderNet APIs

API Reference

Release Notes

Get Started

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

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 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

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 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

Create Character

Headers

Body

Response