get multiple assets

POST

/v2/assets/batch

POST

/v2/assets/batch

curl -X POST https://api.sync.so/v2/assets/batch \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "ids": "ids"
}'

[
  {
    "id": "id",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "type": "AUDIO",
    "visibility": "USER",
    "name": "name",
    "url": "url",
    "size": 1000000,
    "format": "format",
    "inputType": "UPLOAD",
    "durationSeconds": 1.1,
    "thumbnailUrl": "thumbnailUrl",
    "width": 1,
    "height": 1,
    "projectId": "projectId",
    "proxyPath": "proxyPath"
  },
  {
    "id": "id",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "type": "AUDIO",
    "visibility": "USER",
    "name": "name",
    "url": "url",
    "size": 1000000,
    "format": "format",
    "inputType": "UPLOAD",
    "durationSeconds": 1.1,
    "thumbnailUrl": "thumbnailUrl",
    "width": 1,
    "height": 1,
    "projectId": "projectId",
    "proxyPath": "proxyPath"
  }
]

Retrieve multiple assets by ID. Assets you cannot access are omitted from the response.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

idsstring or list of stringsRequired

One asset ID, or a list of 1–100 asset IDs.

Response

Matching assets, in the service response order.

idstring

A unique identifier for an asset.

createdAtdatetime

The date and time the asset was created.

updatedAtdatetime

The date and time the asset was last updated.

typeenum

The type of asset file.

Allowed values:

visibilityenum

Visibility scope for the asset.

Allowed values:

namestringOptional

The filename of the asset.

urlstringOptional

The URL to access the asset media.

sizelongOptional

File size in bytes.

formatstringOptional

File format/extension (e.g., “mp4”, “wav”).

inputTypeenumOptional

The source type of the asset.

durationSecondsdoubleOptional

Duration of the media in seconds (for audio/video).

thumbnailUrlstringOptional

URL to the asset's thumbnail image.

widthintegerOptional

Width in pixels (for video/image).

heightintegerOptional

Height in pixels (for video/image).

projectIdstringOptional

The id of the project this asset is attached to, or null when it belongs to no project.

proxyPathstring or nullOptional

Stable API proxy path for authenticated media playback.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error