API reference

API reference · Account

How the person is told a take landed

GET/api/studio/noticesSigned in session

A take made at the studio's pages, or a whole render plan, is told once when it lands while no studio tab is in view: by the tab's browser notice, else Web Push, else Telegram. These are the person's switches for the last two. A 404 while media jobs are off. The signed in account; same origin for a write.

Answer 200

The person's own switches.

Fields of the 200 answer
FieldTypeWhat it is
pushrequiredobjectWeb Push to the person's devices: available only while the operator set the VAPID variables; off until they turn it on.
push.availablerequiredboolean
push.onrequiredboolean
push.devicesrequiredinteger
telegramrequiredobjectThe person's linked Telegram chat: available only while the bot is configured and a chat is linked; on until they turn it off.
telegram.availablerequiredboolean
telegram.onrequiredboolean

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