Descript

App · 14 actions

Connect Descript to automate video and audio workflows.

Actions

ActionWhat it does
Agent editAgent edit.
Cancel jobCancel job.
Check API statusCheck API status.
Create Import URLCreate Import URL.
Export project transcriptExport project transcript.
Get job statusGet job status.
Get project detailsGet project details.
Get Published Project MetadataGet Published Project Metadata.
Import media and sequencesImport media and sequences.
List agent modelsList agent models.
List jobsList jobs.
List projectsList projects.
Publish project mediaPublish project media.
Search a driveSearch a drive.

Agent edit

Agent edit.

Inputs

Projectproject_idtext
The ID of an existing project to edit. Mutually exclusive with `project_name`.
Project nameproject_nametext
Name for creating a new project. Mutually exclusive with `project_id`.
Composition idcomposition_idtext
Composition to target within the project. When provided, the agent will focus its edits on this specific composition rather than choosing one automatically. Only valid when `project_id` is also provided. Requires `project_id`. Accepts any of the following formats: - A full composition UUID (e.g. `39677a40-1c43-4c36-8449-46cfbc4de2b5`) - A 5-character short ID from a Descript URL (e.g. `39677`) - A full Descript project URL (e.g. `https://web.descript.com/{project_id}/39677`)
Modelmodeltext
AI model to use for editing. Accepts a canonical model id (e.g. `claude-opus-5.5`) or a friendly alias that tracks the stable version of a family (e.g. `claude-opus`). Call [GET /agent/models](#operation/listAgentModels) for the current set of supported models and aliases. Defaults to `auto` when omitted, which selects a recommended model for your account.
PromptprompttextRequired
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"
Team accessteam_accesstext
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.One of: edit, comment, view, none.
Callback urlcallback_urltext
Optional webhook URL to call when the job completes or fails. Descript will POST the job status (same format as [GET /jobs/{job_id}](#operation/getJob)) to this URL.
Conversation idconversation_idtext
Conversation ID from a previous agent response. Pass it back on your next call, with the same `project_id`, so the agent sees prior turns. Omit it to start a new conversation. Requires `project_id`.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "conversation_id": "example",
    "drive_id": "example",
    "drive_name": "example",
    "job_id": "example-job",
    "project_id": "example",
    "project_url": "example",
    "resolved_model": "example"
  }
}

Cancel job

Cancel job.

Inputs

Job idjob_idtextRequired
The job ID

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {}
}

Check API status

Check API status.

Inputs

None.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "api_version": "example",
    "drive_id": "example",
    "drive_name": "example"
  }
}

Create Import URL

Create Import URL.

Inputs

Partner drive idpartner_drive_idtextRequired
The drive id associated with the auth token.
Project schemaproject_schemaobjectRequired
The Project schema

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "url": "example"
  }
}

Export project transcript

Export project transcript.

Inputs

Projectproject_idtextRequired
The ID of the project to export from.
Composition idcomposition_idtext
Composition to export. If omitted, the first composition in the project is used. Accepts any of the following formats: - A full composition UUID (e.g. `39677a40-1c43-4c36-8449-46cfbc4de2b5`) - A 5-character short ID from a Descript URL (e.g. `39677`) - A full Descript project URL (e.g. `https://web.descript.com/{project_id}/39677`)
FormatformattextRequired
Transcript file format. The response body is the raw transcript file in the requested format (binary for `docx`, plain text otherwise). The `srt` format exports a SubRip subtitle file with timed captions.One of: txt, markdown, html, rtf, docx, srt.
Include speaker labelsinclude_speaker_labelstext
Speaker label mode. - `off`: No speaker labels - `changes`: Show speaker label when the speaker changes - `every_paragraph`: Show speaker label on every paragraphOne of: off, changes, every_paragraph (Every paragraph).
Include markersinclude_markerstrue/false
Include markers in the transcript.
Timecodestimecodesobject
Timecode options. When provided, timecodes are included in the output.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "content_type": "example",
    "file_base64": "example",
    "text": "example"
  }
}

Get job status

Get job status.

Inputs

Job idjob_idtextRequired
The job ID

Outputs

Result returned by the service.

responseobject
Status of an async job. The response structure varies based on the job type. Use the `job_type` field to determine which fields will be present.
Example output
{
  "response": {
    "created_at": "2026-10-25T12:00:00Z",
    "drive_id": "example",
    "job_id": "example-job",
    "job_state": "stopped",
    "job_type": "agent",
    "progress": {
      "composition_id": {},
      "label": {},
      "last_update_at": {},
      "percent": {},
      "share_url": {}
    },
    "project_id": "example",
    "project_url": "example",
    "result": {},
    "stopped_at": "2026-10-25T12:00:00Z"
  }
}

Get project details

Get project details.

Inputs

Projectproject_idtextRequired
The project UUID

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "compositions": [],
    "created_at": "2026-10-25T12:00:00Z",
    "drive_id": "example",
    "folder_path": "example",
    "id": "example-id",
    "media_files": {},
    "name": "Example",
    "publishes": [],
    "updated_at": "2026-10-25T12:00:00Z"
  }
}

Get Published Project Metadata

Get Published Project Metadata.

Inputs

Published project slugpublished_project_slugtextRequired
The unique URL slug identifying the published project

Outputs

Result returned by the service.

responseobject
Metadata for a successfully published Descript project
Example output
{
  "response": {
    "download_url": "example",
    "download_url_expires_at": "2026-10-25T12:00:00Z",
    "metadata": {
      "duration_formatted": "example",
      "duration_seconds": 0,
      "published_at": "2026-10-25T12:00:00Z",
      "published_by": {
        "first_name": {},
        "last_name": {}
      },
      "title": "example"
    },
    "privacy": "public",
    "project_id": "example",
    "publish_type": "audio",
    "subtitles": "example"
  }
}

Import media and sequences

Import media and sequences.

Inputs

Projectproject_idtext
Existing project ID to import media into. If not provided, a new project will be created. When importing into an existing project, media filenames must not conflict with existing files.
Project nameproject_nametext
Name for the new project. Only used when project_id is not provided.
Team accessteam_accesstext
Access level for drive members. Only applicable when creating a new project (when project_id is not provided). Defaults to `none` if not specified. - edit: Users can edit the project - comment: Users can view and comment but not edit - view: Users can view but not comment or edit - none: No shared access (private to owner)One of: edit, comment, view, none.
Folder namefolder_nametext
Folder path to place the new project in (e.g. "Clients/Acme/Videos"). Supports nested paths using "/" as separator. Only applicable when creating a new project (when project_id is not provided). Existing folders along the path are reused; missing segments are created automatically.
Workspace nameworkspace_nametext
Existing workspace to create the new project in, matched by name (case-insensitive). Only applicable when creating a new project (when project_id is not provided). Reserved names: `Personal` (your private space) and `General` (the shared drive workspace). Any other value is looked up as a custom workspace name; unknown names return 404. When omitted, `team_access` is passed through unchanged. When set to `Personal`, `team_access` must be `none` or omitted. When set to `General` or a custom workspace name, `team_access` must be `edit`, `comment`, or `view`; omitting it defaults to `view`, and `none` is rejected. For custom workspaces, the caller must be a member of that workspace.
Add mediaadd_mediaobject
Map of media reference IDs (display names with optional folder paths) to media import items. Keys are the display names that will appear in the project (e.g., "Misc/intro.mp4" or "demo.mp4"). Values define how to import each media item (URL import or multitrack sequence).
Add compositionsadd_compositionslist
Optional list of compositions to create in the project
Callback urlcallback_urltext
Optional webhook URL to call when the job completes or fails. Descript will POST the job status (same format as [GET /jobs/{job_id}](#operation/getJob)) to this URL.

Outputs

Result returned by the service.

responseobject
Response returned when creating an import job
Example output
{
  "response": {
    "drive_id": "example",
    "drive_name": "example",
    "job_id": "example-job",
    "project_id": "example",
    "project_url": "example",
    "upload_urls": {}
  }
}

List agent models

List agent models.

Inputs

None.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "aliases": [],
    "availableModels": []
  }
}

List jobs

List jobs.

Inputs

Projectproject_idtext
Filter by project ID
Typetypetext
Filter by job typeOne of: import/project_media (Import/project media), agent.
Cursorcursortext
Cursor for the next page of results, obtained from `pagination.next_cursor` in a previous response
Limitlimitnumber
Number of items per page (1-100). Defaults to 20.From 1 to 100.
Created aftercreated_afterdate and time
Filter jobs created after this timestamp (ISO 8601). Default: 7 days ago. Oldest allowed: 30 days ago.
Created beforecreated_beforedate and time
Filter jobs created before this timestamp (ISO 8601). Default: now.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "pagination": {
      "next_cursor": "example"
    }
  }
}

List projects

List projects.

Inputs

Namenametext
Filter projects whose name contains this string (case-insensitive).
Folder pathfolder_pathtext
Filter projects by folder path (e.g. "Clients/Acme/Videos"). Use "/" to separate nested folders. Returns only projects directly inside the deepest folder.
Created bycreated_bytext
Filter projects created by this user UUID. Pass `me` to filter by the authenticated user.
Created aftercreated_afterdate and time
Filter projects created after this ISO 8601 timestamp.
Created beforecreated_beforedate and time
Filter projects created before this ISO 8601 timestamp.
Updated afterupdated_afterdate and time
Filter projects updated after this ISO 8601 timestamp.
Updated beforeupdated_beforedate and time
Filter projects updated before this ISO 8601 timestamp.
Sortsorttext
Sort field. Defaults to created_at.One of: name, created_at (Created at), updated_at (Updated at), last_viewed_at (Last viewed at).
Directiondirectiontext
Sort direction. Defaults to desc.One of: asc, desc.
Cursorcursortext
Pagination cursor from a previous response's `pagination.next_cursor`.
Limitlimitnumber
Number of projects per page (1-100). Defaults to 20.From 1 to 100.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "pagination": {
      "next_cursor": "example"
    }
  }
}

Publish project media

Publish project media.

Inputs

Projectproject_idtextRequired
The ID of the project to publish.
Composition idcomposition_idtext
Composition to publish. If omitted, the first composition that has content is used, skipping the empty placeholder that leads projects created by an agent or import job. Accepts any of the following formats: - A full composition UUID (e.g. `39677a40-1c43-4c36-8449-46cfbc4de2b5`) - A 5-character short ID from a Descript URL (e.g. `39677`) - A full Descript project URL (e.g. `https://web.descript.com/{project_id}/39677`)
Media typemedia_typetext
Media type of the published output. Defaults to `Video` when omitted. If the target composition has no video content: - omitting `media_type` publishes it as `Audio` (the completed job result reports `media_type: Audio`), - explicitly requesting `Video` is rejected with a 422.One of: Video, Audio.
Resolutionresolutiontext
Resolution for the published output. Only applicable when media_type is Video.One of: 480p, 720p, 1080p, 1440p, 4K.
Callback urlcallback_urltext
Optional webhook URL to call when the job completes or fails. Descript will POST the job status (same format as [GET /jobs/{job_id}](#operation/getJob)) to this URL.
Access levelaccess_leveltext
Desired access level for the published share page. If omitted, the drive's configured default is used. Returns 403 if the requested level is not permitted by the drive's publish settings (e.g. requesting `public` when search engine indexing is disabled).One of: public, unlisted, drive, private.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "drive_id": "example",
    "drive_name": "example",
    "job_id": "example-job",
    "project_id": "example",
    "project_url": "example"
  }
}

Search a drive

Search a drive.

Inputs

QueryquerytextRequired
Search term. Matched against names, contents, and visual matches (on drives with the Enterprise plan). Must be non-empty.
Updated afterupdated_afterdate and time
Return results updated at or after this time. Accepts an ISO 8601 date (`2026-08-01`, interpreted as the start of that UTC day) or timestamp (`2026-08-01T09:30:00Z`). Values without a timezone offset are read as UTC.
Updated beforeupdated_beforedate and time
Return results updated at or before this time. Accepts an ISO 8601 date (`2026-08-01`, interpreted as the end of that UTC day) or timestamp (`2026-08-01T23:59:59Z`). Values without a timezone offset are read as UTC.
Ownerownerlist
Return items owned by these user UUIDs. Repeat this parameter to include more than one owner. If omitted, results from all owners are returned.
Typetypelist
Result types to search. Repeat this parameter to search more than one type. If omitted, all result types are returned. - `project`: Projects - `layout_pack`: Layout packs - `project_folder`: Folders that hold projects - `media_library_folder`: Folders in the drive media library - `video`, `image`, `audio`: Files of that media type in the drive media library, Brand Studio, and inside projectsOne or more of: project, video, image, audio, project_folder (Project folder), media_library_folder (Media library folder), layout_pack (Layout pack).
Matchmatchlist
How the query may match. Repeat this parameter to allow more than one kind. `name` matches project, file, folder, and layout pack names. `content` matches transcripts and composition text. `visual` matches what appears in videos and images, and is only available on drives with the Enterprise plan. `visual` cannot be combined with another match kind. If omitted, only names and contents contribute.One or more of: name, content, visual.
Sortsorttext
How to sort results: - `relevance`: closest matches first. This is the default. - `newest`: most recently modified first. - `oldest`: least recently modified first.One of: relevance, newest, oldest.
Limitlimitnumber
Maximum number of results to return. Defaults to 30. Maximum is 100.From 1 to 100.

Outputs

Result returned by the service.

responseobject
Ranked search results.
Example output
{
  "response": {
    "results": []
  }
}

On this page