Skip to main content
POST
Media Download Async

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
country
string
expected_mime_types
string[]
locale
string
storage
object
callback_url
string

URL to call back when async operation completes

Example:

"https://example.com/webhook/callback"

storage_compress
boolean

Whether to compress stored data

Example:

true

storage_object_name
string

Custom name for the stored object

Example:

"result-2024-01-15.json"

storage_type
string

Type of storage to use for results

Example:

"s3"

storage_url
string

URL for storage location

Example:

"s3://bucket-name/path/to/object"

Response

200 - application/json

Task created successfully

Response when an async media download task is created successfully.

status
string
required

Status indicating the async task was created successfully.

Allowed value: "success"
task
object
required

The created async task details.