API reference

API reference · Account

A stored file's record

GET/api/studio/assets/{id}Signed in session

A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). The signed in account.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe stored file's id, sa_ followed by hex.

Answer 200

The record.

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

Errors

  • 401OpenAI 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