API reference

API reference · Account

Start a file sent in parts

POST/api/studio/uploadsSigned in session

For a file larger than one request carries (the export's Share it). The types and caps of a stored file; parts of 3500000 bytes; at most 4 open (409 too_many_uploads); one not completed in 6 hours is swept with its parts. A 404 with code storage_off while the operator keeps no files for the studio. The signed in account; same origin for a write.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
content_typerequiredstringOne of "image/png", "image/jpeg", "image/webp", "audio/mpeg", "audio/wav", "audio/ogg", "audio/webm", "audio/mp4", "audio/aac", "video/mp4", "video/quicktime", "video/webm".
bytesrequiredintegerAt least 1.
namestring
project_idstring or nullThe film it is kept with.
doc_asset_idstring or null

Example

{
  "content_type": "image/png",
  "bytes": 1
}

Answer 201

The upload, its parts to send.

Fields of the 201 answer
FieldTypeWhat it is
idstring
objectstringOne of "studio.upload".
content_typestring
bytesinteger
part_bytesinteger
partsinteger
parts_receivedinteger
statusstringOne of "open", "completing".
expires_atinteger

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 402OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 413OpenAI shaped error.
  • 415OpenAI 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