API reference

API reference · API

Stored files

GET/v1/studio/assetsAPI key

Newest first; project_id narrows to a project, job_ids (comma separated) to the copies of those jobs. A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). An API key with the read scope. Rate limited per key at the key's own requests a minute, in a window of its own. An agent's key is refused (403 policy_violation). Every /v1/studio door is a 404 while video and sound jobs are switched off.

Parameters

Path and query parameters
FieldTypeWhat it is
limit (query)integer
after (query)stringThe last_id of the previous page.
project_id (query)string
job_ids (query)string

Answer 200

The files.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "list".
dataarray of object
data[].idstring
data[].objectstringOne of "studio.asset".
data[].kindstringOne of "picture", "audio", "clip".
data[].sourcestringOne of "upload", "job".
data[].statusstringOne of "ready", "awaiting", "failed".
data[].project_idstring or null
data[].job_idstring or null
data[].doc_asset_idstring or nullThe editor Asset this file stands for.
data[].namestring or null
data[].content_typestring or null
data[].bytesinteger
data[].sha256string or null
data[].errorstring or null
data[].created_atinteger
data[].updated_atinteger
has_moreboolean
last_idstring or null

Errors

  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter