Docs
Generate Run of Show
POST /Activities/{activityId}/RunOfShow
POST
/Activities/{activityId}/RunOfShowRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Uses AI to generate a run-of-show segment list for the activity based on a natural-language prompt. The generated segments are automatically added to the activity.
This endpoint calls an AI service to produce segment suggestions, so response times may be longer than typical API calls.
Requires EventAdmin permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| activityId | Guid | Required | The ID of the activity to generate segments for. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| userPrompt | string | Required | Natural-language description of the event or run of show you want to generate. The more detail you provide, the better the output. |
Tips for Writing a Good Prompt
- Include the event type (e.g., "award ceremony", "conference", "concert")
- Mention the total duration (e.g., "2-hour show")
- List key moments or segments you want included
- Specify any constraints (e.g., "include a 15-minute break")
Response
Returns 200 OK with no body on success. The generated segments are immediately available via Get Activity Segments.