Skip to content

Create Cards#

Creates Card content (image + text + optional targeting/action link) suitable for feeds, overlays, or other card-based surfaces.

  • Workflow ID: create-cards

Example Request#

{
  "workflows": ["create-cards"],
  "mediaUrls": [
    "https://cdn.example.com/images/card-001.jpg",
    "https://cdn.example.com/images/card-002.jpg"
  ],
  "metadata": {
    "https://cdn.example.com/images/card-001.jpg": {
      "InternalTitle": "Promo: Subscription Sale",
      "AssetType": "Landscape",
      "PublishStatus": "Published",
      "Title": "Save 30% Today",
      "Subtitle": "Limited time only",
      "TextOnImage": true,
      "ActionLinkId": "11111111-1111-1111-1111-111111111111",
      "CategoryIds": ["promo", "featured"],
      "ItemMetadata": {"campaign": "october-sale"},
      "Targeting": [
        {"Attribute": "country", "Operator": "equals", "Value": "US"},
        {"Attribute": "appVersion", "Operator": ">=", "Value": "5.0"}
      ],
      "ExternalId": "card-ext-001",
      "TemplateMetadata": {"tint": "#FFCC00"}
    },
    "https://cdn.example.com/images/card-002.jpg": {
      "InternalTitle": "Promo: New Features",
      "AssetType": "Square",
      "PublishStatus": "Draft",
      "Title": "Try Our New Feature",
      "Subtitle": "Now in beta",
      "TextOnImage": false
    }
  }
}

Metadata#

Key Type Required Remarks
InternalTitle string Yes Per-media. Internal (editorial) title for the card.
AssetType string No Per-media. One of: Vertical, Portrait, ThreeFour, Print, Square, Landscape, Wide.
PublishStatus string No Per-media. Either Draft or Published.
Title string No Per-media. Display title on the card.
Subtitle string No Per-media. Optional subtitle.
TextOnImage boolean No Per-media. If true, renders text over the image.
ActionLinkId Guid No Per-media. Optional action link.
CategoryIds ArrayOf(string) No Per-media. Categories to associate.
ItemMetadata object No Per-media. Arbitrary key/value metadata.
Targeting ArrayOf(object) No Per-media. Audience targeting rules { Attribute, Operator, Value }.
ExternalId string No Per-media. External identifier for the card.
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": ["create-cards"],
  "mediaUrls": ["https://cdn.example.com/images/card-001.jpg"],
  "metadata": {
    "https://cdn.example.com/images/card-001.jpg": {
      "InternalTitle": "Promo: Subscription Sale",
      "AssetType": "Landscape",
      "Title": "Save 30% Today"
    }
  }
}
JSON