Create Audio Description

post

https://api.3playmedia.com/v3/descriptions

Order audio description on one media file in a single call: upload, URL, or an existing media file, plus the order. Narrated in the media's source language, so the one orders[] entry takes no target_language. Packages: launch, refine, accommodate, studio. Turnarounds: standard, asap, flexible. Not every service offers every package or turnaround; List Products shows what your project can order.

The whole request is validated first. If any order is unavailable (package, turnaround, or language pairing), the call returns 400 with the allowed values and nothing is created.

Requests without orders may still use the compatibility fields package and extended (top level), human_review_level and turnaround_level_id. A request with orders accepts none of them; sending any is a 400. external_media_id is also accepted as a compatibility name for external_source_id. The id is not interchangeable with the IDs from /audio_descriptions; use audio_description_id there.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

source

file

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

source_url

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

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

name

string

required

Name of the media file

description

string

Description of the media file

source_language

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

external_source_id

string

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

folder_name

string

Folder to file the media under

callback_url

string

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

instructions

string

Free-text instructions that apply to the whole order

orders

array of objects

Exactly one entry. Audio description is narrated in the media's language, so the entry takes no target_language. Required unless the request uses the compatibility fields; with orders present, any compatibility field is a 400

orders

package

string

enum

Compatibility only, for requests without orders. Use orders[].package instead. Sending it with orders or with human_review_level is a 400

Allowed:

extended

string

enum

Compatibility only, for requests without orders. Use orders[].variant instead (true is extended, false is standard, auto is auto); sending it with orders is a 400

Allowed:

human_review_level

string

enum

Compatibility only, for requests without orders. Use orders[].package instead; sending it with orders is a 400

Allowed:

external_media_id

string

Compatibility only. Same as external_source_id; use that instead

turnaround_level_id

integer

Compatibility only, for requests without orders. Use orders[].turnaround instead; sending it with orders is a 400. 7 maps to standard and 9 to asap. 8 orders Expedited AD (2 days), which has no orders[].turnaround equivalent

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

Callback

202Accepted

400Bad Request. An order is unavailable, a required field is missing, or a compatibility field was sent with orders