> ## Documentation Index > Fetch the complete documentation index at: https://streamloop.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # Read a resource > A resource with its `revision` (also the `ETag`) and `children` (the paths to read next); a type (`frame`, `source/data`, `element/Text`: what it takes, with an example); or a list (a path ending in `/*`). `as=image` on a `frame/` or a layer answers a PNG of it as it goes on air, drawn by the channel's renderer — or, with `Accept: application/json`, the picture as a data URL with what drew (`drawn`) and what is wrong (`issues`: outside title-safe, overlapping, too small, a bound table with no rows). `version` reads a published version instead of the draft. `If-None-Match` with the ETag you hold answers 304 when nothing changed. ## OpenAPI ````yaml /api-reference/scenes-openapi.json get /scenes/{id}/resources/{path} openapi: 3.1.0 info: title: Streamloop Scenes API version: 1.0.0 description: >- Build and run scenes: live, designed streams. A scene (id `scn_…`) holds frames — full arrangements of layers (text, pictures, video, web pages, tables, tickers), one on air at a time — each at `frame/`, plus the sources it reads (cameras, RTMP/SRT inputs, files, playlists, URLs, Google Sheets), its components and its script. You edit its draft as resources at paths (`frame/intro`, `frame/intro/title`, `source/data/headlines`, `component/LowerThird`, `script/show.ts`); every write is built and checked as the Streamloop studio checks it, and studios open on it see it at once. Nothing reaches viewers until you publish. To put a scene on a stream: `PUT /v1/streams/{id}/scene` (Streamloop REST API), then start the stream. This API follows the conventions of Streamloop's REST API: the same authentication (`X-API-Key`, an OAuth bearer, or the dashboard's session), `X-Workspace-Id`, RFC 7807 problems with a stable `code`, cursor pages, `Idempotency-Key` on POST and PATCH, and `RateLimit-*` headers (600 requests a minute). servers: - url: https://api.streamloop.app/v1 security: - apiKey: [] - oauth: [] tags: - name: scenes description: Create, list, read and delete scenes. - name: draft description: >- Read and change the scene's draft, resource by resource. Start with `GET /scenes/{id}/resources` (the kinds of thing it holds) and `GET /scenes/{id}/resources/element/*` (the building blocks and their props). - name: publishing description: Put the draft on air, see what was published, go back. - name: live description: What a stream playing the scene has on air, and the operator's actions. - name: inputs description: >- Live inputs: ingest keys for RTMP/RTMPS/SRT encoders, RTSP cameras, and secrets the scene's tables use. paths: /scenes/{id}/resources/{path}: parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/path' - $ref: '#/components/parameters/workspace' get: tags: - draft summary: Read a resource description: >- A resource with its `revision` (also the `ETag`) and `children` (the paths to read next); a type (`frame`, `source/data`, `element/Text`: what it takes, with an example); or a list (a path ending in `/*`). `as=image` on a `frame/` or a layer answers a PNG of it as it goes on air, drawn by the channel's renderer — or, with `Accept: application/json`, the picture as a data URL with what drew (`drawn`) and what is wrong (`issues`: outside title-safe, overlapping, too small, a bound table with no rows). `version` reads a published version instead of the draft. `If-None-Match` with the ETag you hold answers 304 when nothing changed. operationId: getResource parameters: - name: as in: query schema: type: string enum: - image - json description: >- image: a PNG of a `frame/` (at most 1280 px wide) or a layer (full size); json: a `frame/` as a node tree instead of JSX - name: version in: query schema: type: string description: >- A published version's number (a positive integer), or `published`; anything else is 422 INVALID_INPUT - name: limit in: query schema: type: integer minimum: 1 maximum: 200 description: Rows per page (…/rows) - name: offset in: query schema: type: integer minimum: 0 description: First row (…/rows) - name: at in: query schema: type: number description: 'Picture: ms since that `frame/` went on air' - name: overlay in: query schema: type: string enum: - grid - ids description: 'Picture: a 10 % grid, or each layer''s outline and id' - name: data in: query schema: type: string enum: - live - sample description: >- Picture: bindings read live values (the default: tables as last read) or each table's sample rows. A picture draws the frame as it would go on air — it is not a capture of a running stream: controls and state are at their starting values responses: '200': description: >- The answer, or a PNG for as=image (a picture lists, with Accept: application/json, what didn't draw in `notDrawn` and why in `issues` — an Image whose file the channel can't load among them) headers: ETag: schema: type: string description: The resource's revision; for a PNG, a hash of the picture itself Draft-Revision: schema: type: string description: The draft read (not on a published version's answer) Scene-Version: schema: type: integer description: >- With `version`: the published version read (`published` answers its number); also `version` in the JSON content: application/json: schema: $ref: '#/components/schemas/Answer' image/png: schema: type: string format: binary '304': description: Not changed since the If-None-Match revision '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' 4XX: $ref: '#/components/responses/Problem' 5XX: $ref: '#/components/responses/Problem' components: parameters: id: name: id in: path required: true schema: type: string pattern: ^scn_ description: The scene's id (`scn_…`) path: name: path in: path required: true schema: type: string description: >- A resource path, slashes and all: `frame/intro`, `frame/intro/title`, `source/data/headlines/rows`, `component/LowerThird`, `script/show.ts`, a type (`element/Text`) or a list (`frame/*`) example: frame/intro workspace: name: X-Workspace-Id in: header schema: type: string description: >- The workspace to act in. Required with an API key; otherwise the session's own. schemas: Answer: type: object description: >- What a draft operation answers. `summary` says what happened in a sentence; `value` is what a read found. properties: summary: type: string value: description: >- What was read: a resource (with `revision` and `children`), a type (what it takes), or a list anyOf: - $ref: '#/components/schemas/FrameResource' - $ref: '#/components/schemas/LayerResource' - $ref: '#/components/schemas/TableResource' - $ref: '#/components/schemas/ComponentResource' - $ref: '#/components/schemas/ControlResource' - $ref: '#/components/schemas/CodeResource' - $ref: '#/components/schemas/TypeDescription' - type: array items: $ref: '#/components/schemas/ListEntry' path: type: string description: 'A write: where it is stored (a new id is made unique)' revision: type: string description: 'A write: the resource''s new revision' frameRevision: type: string description: >- A layer's write: the revision of the `frame/` it is in (If-Match takes either) created: type: boolean diff: type: string description: 'A write: a unified diff of what changed' removed: type: array items: type: string draftRevision: type: string description: 'The whole draft as this answer saw it: publish takes it' additionalProperties: true FrameResource: type: object description: frame/ required: - path - revision - code properties: path: type: string revision: type: string name: type: string description: type: string transition: type: object properties: kind: type: string enum: - cut - fade - slide - wipe - dip ms: type: number code: type: string description: Its … element in JSX (stored formatted) sound: type: string description: What it sends to air (read-only) children: type: array items: $ref: '#/components/schemas/Child' LayerResource: type: object description: frame// required: - path - type properties: path: type: string revision: type: string type: type: string description: Text, Stack, Image, … or a component props: type: object additionalProperties: true name: type: string description: type: string ancestors: type: array items: type: string children: type: array items: $ref: '#/components/schemas/Child' TableResource: type: object description: source/data/ (other sources are like it, with their kind's fields) properties: path: type: string revision: type: string name: type: string description: type: string connector: type: string enum: - inline - file - csv - json - xlsx - sheets - html url: type: string file: type: string description: A file table's file (an upload's id) pick: type: string headers: type: object additionalProperties: type: string refreshSeconds: type: number rows: type: array items: type: object schema: type: object description: Its columns (inferred from the rows) children: type: array items: $ref: '#/components/schemas/Child' ComponentResource: type: object description: component/ properties: path: type: string revision: type: string description: type: string props: type: object description: name → JSON Schema takesChildren: type: boolean tsx: type: string builtin: type: boolean ControlResource: type: object description: 'control/: an operator input' properties: path: type: string revision: type: string type: type: string enum: - toggle - text - number - select - button label: type: string description: type: string group: type: string default: {} CodeResource: type: object description: script/show.ts, script/state.ts properties: path: type: string revision: type: string code: type: string TypeDescription: type: object description: 'A type (frame, source/data, element/Text, …): what it takes' properties: path: type: string description: type: string props: type: object additionalProperties: true style: type: object additionalProperties: type: string example: {} subtypes: type: array items: type: object ListEntry: type: object properties: path: type: string name: type: string description: type: string additionalProperties: true Problem: type: object required: - type - title - status - code - detail properties: type: type: string const: about:blank title: type: string status: type: integer code: type: string description: >- Stable — branch on it: BAD_REQUEST (400), WORKSPACE_REQUIRED (400), UNAUTHENTICATED (401), INSUFFICIENT_SCOPE (403), WORKSPACE_FORBIDDEN (403), NOT_FOUND (404), METHOD_NOT_ALLOWED (405), READ_ONLY (422), CONFLICT (409; currentRevision), EDIT_NO_MATCH (409), EDIT_AMBIGUOUS (409), IN_USE (409), CONFIRM_REQUIRED (409), STALE_PUBLISH (409; publishedVersion, basedOn, reverted, publishedVersionIsRevert), REVISION_REQUIRED (MCP only: a set or remove of an existing resource without its revision), NOT_PUBLISHED (409), SCENE_IN_USE (409), DRAFT_NOT_SAVED (409), SCENE_OFFLINE (409), SCENE_REFUSED (409), INGEST_KEY_REVOKED (409), CAMERA_PULL_GONE (409), SECRETS_FULL (409), PRECONDITION_FAILED (412; currentRevision), TOO_LARGE (413), UNSUPPORTED_MEDIA_TYPE (415), INVALID_INPUT (422), IDEMPOTENCY_KEY_REUSED (422), CHECK_FAILED (422), SCENE_INVALID (422), CAMERA_INVALID (422), CAMERA_PRIVATE_ADDRESS (422), SECRET_MISSING (422), RATE_LIMITED (429), CAMERA_TEST_BUSY (429), INTERNAL (500), NOT_SUPPORTED (501), UNAVAILABLE (502 or 503), INGEST_UNAVAILABLE (503), CAMERAS_UNAVAILABLE (503), SECRETS_UNAVAILABLE (503), SCENE_TIMEOUT (504) detail: type: string description: What happened and what to do errors: type: array description: Each problem, when there are several (a check's findings) items: type: object properties: line: type: integer path: type: string node: type: string message: type: string additionalProperties: true currentRevision: type: - string - 'null' description: >- CONFLICT / PRECONDITION_FAILED: the resource's revision now; null when it no longer exists Child: type: object properties: path: type: string description: type: string as: type: string enum: - image args: type: object additionalProperties: type: string responses: BadRequest: description: >- BAD_REQUEST (400): a body or query that can't be parsed (not JSON); INVALID_INPUT (422): one that parses but doesn't fit — an unknown or missing field or query parameter, a value of the wrong type or out of range. `detail` names the field content: application/problem+json: schema: $ref: '#/components/schemas/Problem' NotFound: description: >- NOT_FOUND: no such scene (in this workspace) or resource — `detail` says what there is content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Problem: description: An RFC 7807 problem; branch on `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: >- A Streamloop API key (`sl_…`). It carries no workspace: send `X-Workspace-Id` too (400 WORKSPACE_REQUIRED otherwise). oauth: type: http scheme: bearer description: >- An OAuth access token (as Streamloop's MCP server uses). Each operation needs the scope named in its `x-scope`: streamloop:read ⊂ streamloop:write ⊂ streamloop:destructive (403 INSUFFICIENT_SCOPE). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.