Create Description Scan

Order an audio description scan on one media file in a single call: upload, URL, or an existing media file, plus the order. The scan measures how much of the media needs audio description. It has no package or variant, so orders is optional; leave it out to order at the default turnaround. Not every project or language can order a scan; List Products with type=description_scan shows what your project can order.

The whole request is validated first. If the scan is unavailable (turnaround or source language), the call returns 400 with the reason and nothing is created. A media file takes one scan: a second order on a file whose scan is in progress or complete returns 400 with type duplicate_order. A cancelled scan does not count.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

Media file to upload, sent as multipart form data. Supply exactly one of source, source_url, or media_file_id

string

URL 3Play downloads the media from before processing. Authenticated URLs need at least 1 day of validity. Supply exactly one of source, source_url, or media_file_id

integer

ID of a media file already in 3Play to reuse. Supply exactly one of source, source_url, or media_file_id

string
required

Name of the media file

string

Description of the media file

string
required

Language code of the media (browser navigator code). Accepts a generic (en) or regional (en-US) code; a generic code resolves to the project's default variant

string

Your own key for the media, echoed on each order and in callbacks

string

Folder to file the media under

string

URL 3Play POSTs to once per order when it reaches a terminal status, retried if delivery fails

orders
array of objects

Optional. At most one entry; leave it out to order at the default turnaround. An empty array is a 400

orders
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

Callback
Language
Credentials
Query
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json