API reference

API reference · Account

Comment on a film

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

Pinned to a moment of the cut (at, seconds) or to one of its takes (asset_id), one of the two. At most 2000 characters, 500 a film (409 too_many_comments). 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.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
bodyrequiredstringAt most 2000 characters.
atnumberAt least 0.
asset_idstringAt most 80 characters.
labelstringAt most 120 characters.

Example

{
  "body": "string",
  "at": 0,
  "asset_id": "string",
  "label": "string"
}

Answer 201

The comment.

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

Errors

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