Add Page

Adds a Page to an existing Story by internal storyId. Use when you need to append new pages (video segments) to a known Story.

• Workflow ID: add-to-story

Example Request

{
  "workflows": ["add-to-story"],
  "mediaUrls": [
    "https://cdn.example.com/videos/story-123-page-01.mp4",
    "https://cdn.example.com/videos/story-123-page-02.mp4"
  ],
  "metadata": {
    "StoryId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",

    "https://cdn.example.com/videos/story-123-page-01.mp4": {
      "SortOrder": 1,
      "Duration": 12,
      "IsHidden": false,
      "SkipUpdatingAsset": false,
      "SkipProcessing": false,
      "ActionLinkId": "11111111-1111-1111-1111-111111111111",
      "ExternalId": "ext-page-01",
      "CategoryIds": ["matchday", "featured"],
      "TemplateMetadata": { "overlay": "score" }
    },
    "https://cdn.example.com/videos/story-123-page-02.mp4": {
      "SortOrder": 2,
      "Duration": 9,
      "IsHidden": false,
      "SkipUpdatingAsset": true,
      "SkipProcessing": false,
      "ExternalId": "ext-page-02"
    }
  }
}

Metadata

Key	Type	Required	Remarks
StoryId	Guid	Yes	Root-level or per-media. Internal Story ID to add this page to.
SortOrder	integer	No	Per-media. Page order within the story.
Duration	integer	No	Per-media. Duration in seconds.
IsHidden	boolean	No	Per-media. Whether the page is hidden.
SkipUpdatingAsset	boolean	No	Per-media. If true, does not update the existing asset when present.
SkipProcessing	boolean	No	Per-media. If true, skip media processing for this page.
ActionLinkId	Guid	No	Per-media. Associate an action link with the page.
CategoryIds	ArrayOf(string)	No	Per-media. Category external IDs to associate with the story during this page add.
ExternalId	string	No	Per-media. External identifier for the page asset.
ExternalCallback	string	No	Per-media. Callback token you can correlate.
TemplateMetadata	object	No	Per-media. Template-specific values when using templates.

cURL Example

curl -X POST "https://integrations.usestoryteller.com/api/workflows/execute" \
  -H "x-storyteller-api-key: $ST_API_KEY" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "workflows": ["add-to-story"],
  "mediaUrls": [
    "https://cdn.example.com/videos/story-123-page-01.mp4"
  ],
  "metadata": {
    "StoryId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "https://cdn.example.com/videos/story-123-page-01.mp4": {
      "SortOrder": 1,
      "Duration": 12,
      "ExternalId": "ext-page-01"
    }
  }
}
JSON