Skip to main content
Note: The Edit in Descript integration requires contacting Descript for access. Reach out to us to get started.
Edit in Descript API enables partners to give their users the ability to transfer audio or video content to Descript for editing. Edit in Descript buttons work by generating one-time use, public Import URLs to the Descript import UI that users can be automatically sent to. On that page, they can make a few simple selections before kicking off a Partner cloud storage to Descript cloud storage transfer. This will redirect them to a Descript Project ready for editing. Partners can initiate the request by securely sending an information schema backend-to-backend to the Descript API using a token, in exchange for the Import URL to redirect the user. Partners do not need to store this schema, as Descript will do so and use it to start fetching the files when the user confirms the action
  1. When a user clicks Edit in Descript, partner’s backend service makes POST request to: https://descriptapi.com/v1/edit_in_descript/schema with an authorization bearer token header and JSON schema body
  2. Descript responds with either an Import URL or an error
  3. Partner redirects the user’s browser to the URL returned in step 2 or display an error message and link to help documentation

​
Partner User Experience

Some guidelines for partners as you consider this integration:
  • We recommend placing the Edit in Descript option next to your download options
    • If you offer multiple download options, such as combined vs. split audio/video files, we recommend placing this integration clearly in context with each option, or only the supported option, to help users understand what will be exported.
    • Each time you request an import link, a new one is generated. Import links expire after 3 hours. After using an import link, the only way to find an imported Project again is in Descript.
    • If an import link has expired or the contents of the schema has changed, please request a new import link with the updated schema. This will create a new Descript Project when used.
  • We will provide Descript-branded assets to fit your proposed placement of the Edit in Descript CTA and ask that you don’t edit the assets beyond what we provide. We are happy to work with you on getting you the right assets for your placement.
  • Partners should provide error-handling for the POST request, at minimum displaying a generic error message and linking to a help article (we can provide a link for this if you prefer).
  • Progress will be conveyed to the user in the Descript side of the user experience.

​
Descript User Experience

When users are directed to a Descript Import URL, they’ll be asked to either create an account or login in order to proceed. Next, they will be presented with a few options about how they’d like to import the data, such as where the new Descript Project should be created. They’ll then be redirected to the Project, where they can monitor the progress of the import and start editing.