API reference

API reference · Account

A film's comments

GET/api/studio/projects/{id}/commentsSigned in session

Oldest first, each pinned to a moment of the cut or to a take, with how many are open. Whoever may open the film: its maker, and for a team's film every member whose role edits films (owner, admin, member). The signed in account; same origin for a write.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe project's id, stp_ followed by hex.

Answer 200

The comments.

Fields of the 200 answer
FieldTypeWhat it is
objectstring
dataarray of object
data[].idstring
data[].objectstringOne of "studio.comment".
data[].bodystring
data[].atnumber or nullThe moment of the cut, seconds.
data[].asset_idstring or nullThe take it is on.
data[].labelstring or null
data[].authorobjectWho saved or wrote it: you, or a teammate by their wallet, shortened.
data[].author.youboolean
data[].author.labelstring or null
data[].created_atinteger
data[].resolved_atinteger or null
data[].resolved_byobject or null
data[].can_deleteboolean
openinteger

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