API reference · Account
Say where you are in a team's film, and hear who else is
POST/api/studio/projects/{id}/presenceSigned in session
The editor beats every 10 s while the film is open and seen: the playhead (at, seconds into the film) and the clip in hand. The answer names every other person whose last beat is younger than 30 s. Send back me as prev (this beat replaces it) and cursor as after (older beats are not read). A film of one's own answers team: false and keeps nothing; ask again after 5 minutes. Beats never reach the film's progress stream. 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
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The project's id, stp_ followed by hex. |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| atrequired | number | From 0 to 21600. |
| clip | string or null | At most 100 characters. |
| prev | integer | At least 1. |
| after | integer | At least 0. |
Example
{
"at": 0,
"clip": "string",
"prev": 1,
"after": 0
}Answer 200
Who else is in the film.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "studio.presence". |
| team | boolean | |
| me | integer or null | |
| cursor | integer | |
| crew | array of object | |
| crew[] | string or null | |
| crew[] | number | |
| crew[] | string or null | |
| crew[] | integer | Seconds since their beat. |
Errors
- 400OpenAI shaped error.
- 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.