Studio Captions

List user's studio captions

Info

Required scope: studio.read

Warning

This method requires authentication

Retrieve a list of all studio captions belonging to the authenticated user.

Captions can optionally be linked to a brand via the brandId field. When brandId is null, the caption is not associated with any brand.

The defaultLabel field identifies system-provided default captions (e.g. "outro"). User-created captions have defaultLabel set to null.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/studio/captions

Response

Success

Error

{
  "captions": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "text": "Welcome to the stream!",
      "secondaryText": "Follow for more content",
      "tags": ["greeting", "intro"],
      "orderId": 1,
      "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "defaultLabel": null,
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-02-20T14:45:00.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "text": "Thanks for watching!",
      "secondaryText": null,
      "tags": null,
      "orderId": 2,
      "brandId": null,
      "defaultLabel": "outro",
      "createdAt": "2026-01-16T09:00:00.000Z",
      "updatedAt": null
    }
  ]
}