Skip to main content
POST
/
v1
/
media
/
async
Media Download Async
curl --request POST \
  --url https://sdk.nimbleway.com/v1/media/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/product-image.jpg",
  "country": "US",
  "locale": "en-US",
  "expected_mime_types": [
    "image/*"
  ],
  "storage": {
    "url": "s3://my-bucket/media/",
    "type": "s3",
    "object_name": "my-image"
  }
}
'
{
  "status": "success",
  "task": {
    "id": "52907745-7672-470e-1231-a2f8feb52944",
    "state": "pending",
    "created_at": "2026-03-02T12:00:00.000Z",
    "modified_at": "2026-03-02T12:00:00.000Z",
    "account_name": "my-account",
    "api_type": "media",
    "input": {
      "url": "https://example.com/product-image.jpg",
      "country": "US",
      "locale": "en-US",
      "expected_mime_types": [
        "image/*"
      ],
      "storage": {
        "url": "s3://my-bucket/media/",
        "type": "s3",
        "object_name": "product-123"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt

Use this file to discover all available pages before exploring further.

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

URL of the media file to download

Example:

"https://example.com/image.jpg"

​
country
string
default:US

Country used to access the target URL, use ISO Alpha-2 Codes

Required string length: 2
Example:

"US"

​
locale
string

LCID standard locale used for the URL request. Alternatively, user can use 'auto' for automatic locale based on geo-location

Example:

"en-US"

​
expected_mime_types
string[]

Allowed MIME types (supports wildcards like image/*)

Example:
["image/*", "video/mp4"]
​
storage_type
enum<string>

Storage type for async results. Use s3 for Amazon S3 and gs for Google Cloud Platform.

Available options:
s3,
gs
Example:

"s3"

​
storage_url
string

Repository URL where output will be saved. Format: s3://Your.Bucket.Name/your/object/name/prefix/ - Output will be saved as TASK_ID.json

Example:

"s3://Your.Repository.Path/"

​
callback_url
string<uri>

A URL to callback once the data is delivered. The API will send a POST request with task details (without the requested data) when the task completes.

Example:

"https://your.callback.url/path"

​
storage_compress
boolean

When set to true, the response saved to storage_url will be compressed using GZIP format. If false or not set, response will be saved uncompressed.

Example:

false

​
storage_object_name
string

Custom name for the stored object instead of the default task ID

Example:

"my task"

Response

Successful Response

​
status
string
required
Example:

"success"

​
task
object
required