Generate Media

Start using mode in character object while generating images using character.

weight and enable_facelock are deprecated and will be removed in the future.

Example:

[
    {
        .
        .
        "character": {
            "character_id": "char_001",
            "mode": "balanced"
        }
        .
        .
    }
]

Added support for Video Anyone generation

Any attempt to produce NSFW, violent, or public figure content will result in permanent account termination.

You can use either a generated image’s media_id or an uploaded image asset’s asset_id as the input image identifier media_id for video generation, eliminating the need to re-upload images as assets.

Example request

[
    {
        "video_anyone": {
            "media_id": "ast_xxxxxxxx",
            "prompt": "A person riding a bicycle",
            "duration": 5
        }
    }
]

For video_anyone generation make sure that input image meets the following conditions to avoid generation failure:

Input image aspect ratio should be either 3:5 or 5:3.
Maximum characters permitted for prompt is 500 only.

When using the generation array, ensure that each object contains only one of the following properties: segment, style, model, true_touch, narrator or video_anyone. These properties have a priority order as follows:

segment
style
model
true_touch
narrator
video_anyone

If multiple properties are provided, the one with the highest priority will be used.

The narrator can be generated either by using a script paired with a voice(List all the available voices using GET /pub/v1/voices endpoint) or by utilizing an existing audio asset.

segment, true_touch, narrator and video_anyone generations only acknowledge parameters that are passed within their own objects.

For narrator generation make sure that video asset meets the following conditions to avoid generation failure:

The maximum supported frame rate for a video asset is 30 FPS, calculated by dividing the total number of frames by the total duration.
Maximum height and width of the video asset should be 1080 and 1920 respectively.

Headers

X-API-KEY

string

required

API key needed to access our public endpoints. You can find yours under the 'Account' section of the website

Body

application/json

aspect_ratio

enum<string>

The aspect ratio of the image for the generation

Available options:

1:1,

2:3,

3:2,

4:5,

16:9,

9:16

Example:

"1:1"

batch_size

integer

The batch size of the generation (Max permissible value depends on your subscription plan). Visit RenderNet pricing for more details

Example:

1

cfg_scale

number

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)

Required range: 4 <= x <= 12

Example:

7

character

object

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

Show child attributes

character.character_id

string

required

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

Example:

"chr_01"

character.mode

enum<string>

required

The mode of the character.

flexible - Ideal for stylized characters and image generations.
balanced - Ideal for creating realistic images and more.
strong - Character similarity is most important.

Available options:

flexible,

balanced,

strong

Example:

"balanced"

character.weight

number

deprecated

This parameter is deprecated, use just mode instead

Required range: 0.1 <= x <= 1

Example:

0.6

character.enable_facelock

boolean

deprecated

This parameter is deprecated, use just mode instead

Example:

true

control_net

object

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

Show child attributes

control_net.asset_id

string

required

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.

Example:

"ast_01"

control_net.control_mode

enum<integer>

required

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.

Available options:

0,

1,

2

Example:

0

control_net.name

string

required

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.

Example:

"Normal"

control_net.resize_mode

enum<integer>

required

The relation between the control net image and generated image:

0 - Resize and Fill.
1 - Crop and Resize.
2 - Just Resize.

Available options:

0,

1,

2

Example:

0

facelock

object

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

Show child attributes

facelock.asset_id

string

required

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.

Example:

"ast_01"

loras

object[]

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.

Show child attributes

loras.name

string

required

The name of the lora

Example:

"lora_name"

loras.weight

number

required

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

Required range: 0.1 <= x <= 1

Example:

0.5

model

string

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

Example:

"JuggernautXL"

narrator

object

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

Show child attributes

narrator.video_asset_id

string

required

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.

Example:

"ast_vidxxxxx"

narrator.image_asset_id

string

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.

Example:

"ast_imgxxxxx"

narrator.audio_asset_id

string

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.

Example:

"ast_audxxxxx"

narrator.script

string

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

Example:

"Thank you for trying Narrator"

narrator.voice

string

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

Example:

"Rachel"

prompt

object

The prompt for the generation

Show child attributes

prompt.negative

string

required

The negative prompt

Example:

"nsfw, deformed, extra limbs, bad anatomy, deformed pupils, text, worst quality, jpeg artifacts, ugly, duplicate, morbid, mutilated"

prompt.positive

string

required

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

Example:

"a man looking into the camera"

quality

enum<string>

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

Available options:

Plus,

Regular

Example:

"Plus"

sampler

enum<string>

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

Available options:

DPM++ 2M Karras,

DPM++ 2M SDE Karras,

DPM++ 2S a Karras,

DPM++ SDE,

DPM++ SDE Karras,

Euler a

Example:

"DPM++ 2M Karras"

seed

integer

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

Example:

1234

segment

object

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

Show child attributes

segment.asset_id

string

required

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

Example:

"ast_01"

segment.find

string

required

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

Example:

"red shirt"

segment.replace

string

required

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

Example:

"blue shirt"

steps

integer

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

Required range: 10 <= x <= 30

Example:

20

style

string

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

Example:

"Bokeh"

style_detail

object

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

Show child attributes

style_detail.name

string

The name of the style

Example:

"Black & White"

style_detail.base_model

string

The base model of the style

Example:

"flux"

true_touch

object

Enhances and upscales the input image passed in the asset_id

Show child attributes

true_touch.asset_id

string

required

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

Example:

"ast_01"

true_touch.enhance_strength

number

required

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

Example:

0.5

true_touch.scale_factor

enum<number>

required

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

Available options:

1,

1.5,

2,

2.5,

3

Example:

1.5

video_anyone

object

Convert image to video seamlessly.

Show child attributes

video_anyone.media_id

string

required

This can be either generated image's media_id or an uploaded image asset's asset_id that you want to convert to video. (Supported Aspect Ratio: 3:5 or 5:3)

Example:

"ast_01"

video_anyone.prompt

string

A simple prompt to be described that what subject wants to be done in the video. (The video prompt is not mandatory input for generating video. You can choose to skip it, and we will create a video based on the source image)

Example:

"Camera static, a woman riding a bicycle"

video_anyone.duration

enum<number>

default:5

Duration of the output video in seconds

Available options:

5,

10

Example:

5

Response

201 - application/json

A list of submitted generation requests

data

object

Show child attributes

data.credits_remaining

integer

The number of credits remaining

Example:

20

data.generation_id

string

The id of the generation

Example:

"gen_01"

data.media

object[]

Show child attributes

data.media.id

string

The id of the media

Example:

"model_01"

data.media.dim

object

Show child attributes

data.media.dim.height

integer

required

The height of the image

Example:

512

data.media.dim.width

integer

required

The width of the image

Example:

512

data.media.model

string

The model used for the media if model is used in the generation else it won't be present

Example:

"JuggernautXL"

data.media.status

string

The status of the image

Example:

"initiated"

data.media.style

string

The style used for the media if style is used in the generation else it won't be present

Example:

"Bokeh"

data.media.style_detail

object

The style name along with its base model used for the generation. This will only be present in case of a style generation.

Show child attributes

data.media.style_detail.name

string

The name of the style

Example:

"Black & White"

data.media.style_detail.base_model

string

The base model of the style

Example:

"flux"

data.media.type

string

The type of the media generation.

Example:

"image"

data.result

string

The result status of the generation

Example:

"initiated"

err

object

The error if the request was not successful

API Documentation

Generations

Assets V2

Assets

Characters

Resources

Headers

Body

Response