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.

Authentification

x-api-keystring

Authentification par clé API via en-tête

Requête

This endpoint expects an object.

idsstring or list of stringsRequis

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

Réponse

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.

Valeurs autorisées:

visibilityenum

Visibility scope for the asset.

Valeurs autorisées:

namestringOptionnel

The filename of the asset.

urlstringOptionnel

The URL to access the asset media.

sizelongOptionnel

File size in bytes.

formatstringOptionnel

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

inputTypeenumOptionnel

The source type of the asset.

durationSecondsdoubleOptionnel

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

thumbnailUrlstringOptionnel

URL to the asset's thumbnail image.

widthintegerOptionnel

Width in pixels (for video/image).

heightintegerOptionnel

Height in pixels (for video/image).

projectIdstringOptionnel

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

proxyPathstring or nullOptionnel

Stable API proxy path for authenticated media playback.

Erreurs

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error