Get started

Introduction

Rendley lets your backend create and edit complete video projects. Send source media with a plain-language brief, or ask the agent to build a video from scratch.

Use the agent when you want Rendley to make creative and editing decisions. Use the focused AI endpoints when you need one specific operation, such as generating an image, creating music, translating speech, removing a background, or upscaling footage.

Agent runs produce an editable Rendley project. You can refine that project with follow-up prompts, open it in Rendley Studio, or export it when it is ready.

API basics


Base URL	`https://api.rendley.com/v1`
Authentication	`Authorization: Bearer YOUR_API_KEY`
Response format	JSON, with successful results under `data` and failures under `error`
Long-running work	Returns a job id that you poll until it reaches a terminal status

Most generation, transformation, agent, and export requests run asynchronously. A successful HTTP response means the job was accepted. It does not mean the work has finished.

Choose the right surface

Agent APIPOST /v1/agent

You want a complete edit from a brief and are comfortable letting the agent make timeline decisions.

AI endpoints/v1/ai/*

You need one predictable operation, such as generation, transcription, translation, background removal, or upscaling.

Projects and uploads/v1/projects/v1/workspaces/{workspaceId}/library

You want to manage editable projects or bring your own media into Rendley storage.

Export APIPOST /v1/projects/{projectId}/exportPOST /v1/export

You have a Rendley project or render-ready project JSON and need a downloadable video.

The fields inside params are model-specific. Use GET /v1/ai/models to list available models and GET /v1/ai/models/{modelId} to retrieve the current JSON Schema before you validate or construct a request.

How it works

A typical automated edit moves through four stages. Starting the edit and starting the export each take one request. The two background jobs require polling until they finish.

Describe the videoPOST /v1/agentSend your prompt and your footage. It answers straight away, before any work starts, with a job_id to follow, a project_id for the project being built, and a thread_id for the conversation. Keep all three.
Rendley builds itGET /v1/agent/jobs/{job_id}Transcription, cuts, timeline, and generated footage for whatever is missing. Ask for the job until status reads completed.
Refine, or take overPOST /v1/agentSend another prompt with the same project_id and thread_id and it adjusts what was built instead of starting over. Or open the project in Rendley Studio and finish it by hand.
ExportPOST /v1/projects/{project_id}/exportRenders the project to MP4. Export uses the standard job endpoint, not the agent job endpoint. The completed export job carries a temporary download URL.