Use a background agent to create and edit projects using a natural language prompt.
project_id to edit an existing projectproject_name instead of project_id to create a new projectAgent edits run in the background and return a job_id. Monitor progress via the GET /jobs/ endpoint.
If callback_url is provided, Descript will POST the job status to that URL when the job completes or fails.
The payload will match the format returned by GET /jobs/.
Personal API token created in Descript Settings → API Tokens. See the Authentication section for details.
AI agent request
Request to run Agent edit.
The agent will interpret the prompt and either edit an existing project or create a new one.
You must provide exactly one of project_id or project_name.
Natural language instruction for the agent to execute. Examples: "add studio sound to every clip", "remove all filler words", "create a 30-second highlight reel"
"add studio sound to every clip"
The ID of an existing project to edit. Mutually exclusive with project_name.
"9f36ee32-5a2c-47e7-b1a3-94991d3e3ddb"
Name for creating a new project. Mutually exclusive with project_id.
"My New Project"
[Work in progress] This property is accepted but not yet functional. It will be ignored.
Optional composition ID within the project to edit.
"39677a40-1c43-4c36-8449-46cfbc4de2b5"
AI model to use for editing. Defaults to the default model.
Access level for team members when creating a new project.
Only applicable when project_name is provided (not when using project_id).
Defaults to none if not specified.
edit, comment, view, none Optional webhook URL to call when the job completes or fails. Descript will POST the job status (same format as GET /jobs/{job_id}) to this URL.
"https://example.com/webhooks/descript/job_callback"
Agent edit job created successfully
Unique identifier for the Agent edit job
"6dc3f30a-58c2-4174-96a6-dc18cf3c7776"
Drive ID where the project is located
"c9c5c47e-158a-49f7-846b-4f6ee2a229a2"
The project ID (existing or newly created)
"9f36ee32-5a2c-47e7-b1a3-94991d3e3ddb"
URL to access the project in Descript web app
"https://web.descript.com/9f36ee32-5a2c-47e7-b1a3-94991d3e3ddb"