Push data to a data stream
singular_push_datastreamPush JSON payloads to a data stream for sub-300ms delivery into linked live graphics compositions, bypassing control API rate limits.
Instructions
PUT a JSON payload to a data stream for sub-300ms delivery into any composition linked to it (scores, clocks, live stats) — bypasses the control API's per-minute rate limits. The payload shape must match what the linked sub-composition expects (configured in the Dashboard). Hard limit: 60 KB per package.
Args: stream (alias) or privateToken; data (JSON object); response_format. Returns { success, bytes }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | JSON to push (object, array, or primitive); an object matching the linked sub-composition's payload shape is typical. | |
| stream | No | Alias of a registered data stream (preferred). | |
| privateToken | No | Raw data-stream private token, if not registered. | |
| response_format | No | Output format: 'markdown' (human-readable) or 'json' (machine-readable). Default 'markdown'. | markdown |