Rendley docs

AI image

Generate images, remove backgrounds, and upscale. All image generation is asynchronous — you start a job and poll until it completes.

Call this endpoint to discover every action, its available models, and the JSON schema each model accepts for params. Use the schema from the response to build your params object in step 2.

Step 2 is the specific generation endpoint below. Pick the one you need, pass project_id, optionally model_id, and the params from the schema above.

#Generate an image

POST/v1/ai/generate-image

Enqueue a job to generate an image from a text prompt, or edit an existing image.

Request body

model_idstringOptional

Which model to use. Call GET /ai/tools to see available models. Each action has a default.

paramsjsonRequired

Model-specific parameters. Call GET /ai/tools to get the schema for each model.

project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

402

Payment Required

#Calculate image generation cost

POST/v1/ai/generate-image/cost

Calculate the credit cost of generating or editing an image.

Request body

model_idstringOptional
paramsobjectOptional
project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

#Remove image background

POST/v1/ai/remove-image-background

Enqueue a job to remove the background from an image, leaving only the foreground subject.

Request body

clip_idstringOptional
file_urlstringOptional
model_idstringOptional

Which model to use. Call GET /ai/tools to see available models. Each action has a default.

paramsjsonRequired

Model-specific parameters. Call GET /ai/tools to get the schema for each model.

project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

402

Payment Required

#Calculate remove image background cost

POST/v1/ai/remove-image-background/cost

Calculate the credit cost of removing the background from an image.

Request body

clip_idstringOptional
file_urlstringOptional
model_idstringOptional
paramsobjectOptional
project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

#Upscale an image

POST/v1/ai/upscale-image

Enqueue a job to upscale an existing image to higher resolution using AI super-resolution.

Request body

clip_idstringOptional
file_urlstringOptional
model_idstringOptional

Which model to use. Call GET /ai/tools to see available models. Each action has a default.

paramsjsonRequired

Model-specific parameters. Call GET /ai/tools to get the schema for each model.

project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

402

Payment Required

#Calculate image upscale cost

POST/v1/ai/upscale-image/cost

Calculate the credit cost of upscaling an image to higher resolution.

Request body

clip_idstringOptional
file_urlstringOptional
model_idstringOptional
paramsobjectOptional
project_idstringRequired
Response codes
200

OK

400

Bad Request

401

Unauthorized

#Step 3: Poll the job

GET/v1/jobs/{job_id}

Poll this endpoint every few seconds until status is completed or failed. See Jobs and polling for the full loop.

The result contains a media_id and file_hash. Use the next step to get a download URL.

Pass the file_hash from the completed job to get a presigned download URL. The storage_url is time-limited, so download the file promptly.