Create a cue
Show module
POST/cuescues.create
A cue in a run of show. Creates a cue. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability show.run_of_show.write.
- OAuth scopes: show.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: CueCreate
| Field | Type | Required | Description |
|---|---|---|---|
| run_of_show_id | string (uuid) | Yes | Identifier of the run of show. |
| position | integer | Yes | Cue order.Constraints: range 1 to any |
| label | string | Yes | Cue title.Constraints: length 1 to 300 |
| planned_at | string (date-time) | null | No | Planned cue time. |
| duration | string | null | No | Planned length as hours:minutes:seconds.Constraints: pattern ^\d{2,}:\d{2}:\d{2}(\.\d+)?$ |
| segment | string | null | No | Show segment the cue belongs to.Constraints: length 1 to 200 |
| description | string | null | No | What happens on the cue.Constraints: length 1 to 2000 |
| space_id | string (uuid) | null | No | Identifier of the space the cue happens in. |
{
"run_of_show_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 10,
"label": "Headliner Walk-On",
"planned_at": "2026-10-08T14:30:00Z",
"duration": "00:05:00",
"segment": "Act II, Official Opening and Remarks",
"description": "House lights to half; walk-in music fades.",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: Cue
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the cue. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| run_of_show_id | string (uuid) | Yes | Identifier of the run of show. |
| position | integer | Yes | Cue order.Constraints: range 1 to any |
| label | string | Yes | Cue title.Constraints: length 1 to 300 |
| planned_at | string (date-time) | null | Yes | Planned cue time. |
| called_at | string (date-time) | null | Yes | When the cue was called. |
| duration | string | null | Yes | Planned length as hours:minutes:seconds.Constraints: pattern ^\d{2,}:\d{2}:\d{2}(\.\d+)?$ |
| called_by | string (uuid) | null | Yes | Identifier of the person who called the cue, set by app.call_cue. |
| project_id | string (uuid) | Yes | Identifier of the project of the running order, stamped by the database. |
| segment | string | null | Yes | Show segment the cue belongs to.Constraints: length 1 to 200 |
| description | string | null | Yes | What happens on the cue.Constraints: length 1 to 2000 |
| space_id | string (uuid) | null | Yes | Identifier of the space the cue happens in. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"run_of_show_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 10,
"label": "Headliner Walk-On",
"planned_at": "2026-10-08T14:30:00Z",
"called_at": "2026-10-08T14:30:00Z",
"duration": "00:05:00",
"called_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"segment": "Act II, Official Opening and Remarks",
"description": "House lights to half; walk-in music fades.",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/cues" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"run_of_show_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":10,"label":"Headliner Walk-On","planned_at":"2026-10-08T14:30:00Z","duration":"00:05:00","segment":"Act II, Official Opening and Remarks","description":"House lights to half; walk-in music fades.","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.cues.create({
"run_of_show_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 10,
"label": "Headliner Walk-On",
"planned_at": "2026-10-08T14:30:00Z",
"duration": "00:05:00",
"segment": "Act II, Official Opening and Remarks",
"description": "House lights to half; walk-in music fades.",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.cues.create({"run_of_show_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 10, "label": "Headliner Walk-On", "planned_at": "2026-10-08T14:30:00Z", "duration": "00:05:00", "segment": "Act II, Official Opening and Remarks", "description": "House lights to half; walk-in music fades.", "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos cues create --data '{"run_of_show_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":10,"label":"Headliner Walk-On","planned_at":"2026-10-08T14:30:00Z","duration":"00:05:00","segment":"Act II, Official Opening and Remarks","description":"House lights to half; walk-in music fades.","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'