Edit in Descript

Create an Import URL by sending a Project schema to Descript API from your service’s backend.

Import Schema

Our import schemas are specified as a minimal JSON list of files which is detailed in full at the bottom of this section. At it’s smallest, the request body looks like:

{
  "partner_drive_id": "162c61d1-6ced-4b25-a622-7dba922983ee",
  "project_schema": {
    "schema_version": "1.0.0",
    "files": [{"uri": "https://descriptusercontent.com/jane.wav?signature=d182bca64bf94a1483d2fd16b579f955"}]
  }
}

File Access

The file paths provided in the schema need to either be public or pre-signed URIs with enough time before expiration for failures and retries, we suggest URIs that won’t expire for 48 hours. We ask that the files have already been saved when the import link is generated to minimize cases where we’re waiting for eventually consistent storage of files that will never be written. We will, however, wait for eventual consistency of the storage layer and retry fetching files before eventually timing out.

Files must be hosted on preapproved hosts as our import process has an allow list which it checks URIs against. Files will be requested with User-Agent: Descriptbot/1.0 (version may change) for tracking purposes.

Import link expiration

Import links are no longer valid after a user imports their data once. Viewing an already used import link will not allow for importing again and will not provide access to a previously created Descript Project. Partners are able to generate a new import link at any time, regardless of if a previous import link has been used.

The API does not currently provide partners with a link to the Descript Project, though users will be redirected to it from Descript’s web interface the first time they import files, and can always find the Project in Descript.

Import links expire after 3 hours and attempting to use an import link after the pre-signed links in the schema file have expired will result in an error, so we recommend generating the import link after the user has clicked the Edit in Descript button.

Supported media specification

We recommend sending the highest quality, uncompressed versions of files available to you. If you have multiple tracks, we recommend prioritizing sending us the full multi-track sequence over a combined file.

• Audio: WAV, FLAC, AAC, MP3
• Video: h264, HEVC (container: MOV, MP4)

POST /edit_in_descript/schema

Create Import URL

cURL

curl --request POST \
  --url https://descriptapi.com/v1/edit_in_descript/schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "partner_drive_id": "aa3b2d8d-e5ca-41c2-8801-683328293fb9",
  "project_schema": {
    "schema_version": "1.0.0",
    "files": [
      {
        "name": "Jane's studio recording",
        "uri": "https://descriptusercontent.com/jane.wav?signature=d182bca64bf94a1483d2fd16b579f955",
        "start_offset": {
          "seconds": 10
        }
      }
    ],
    "source_id": "06b3f5bb-68a2-468a-a5d9-df155c1e3588"
  }
}
EOF

201

{
  "url": "https://web.descript.com/import?nonce=6e3625ca-f885-460d-b2e3-e3faac79c788"
}

Authorizations

Authorization · string · header · required

Personal API token created in Descript Settings → API Tokens. See the Authentication section for details.

Body

application/json

Edit in Descript schema POST body.

partner_drive_id · string<uuid> · required

The drive id associated with the auth token.

Example:

"aa3b2d8d-e5ca-41c2-8801-683328293fb9"

project_schema · object · required

The Project schema

Show child attributes

Response

201

application/json

Successful operation.

url · string<url>

A url for partners to redirect their user to in order to start the import process—expires after 3 hours.

Example:

"https://web.descript.com/import?nonce=6e3625ca-f885-460d-b2e3-e3faac79c788"