Tool reference/carousels

CAROUSELS

generate_carousel

Queue a real 3–10 slide carousel for an owned product. Uses reviewed product audiences by default. Costs 5 credits per AI-generated image; an optional existing CTA image replaces the final generated slide. Poll get_carousel; creation does not publish.

Mutationcreate:carousels
Take the docs with youMarkdown for your editor or agent.
Download guide
TransportStreamable HTTP
Methodtools/call
ExecutionImmediate handler

Every new action requires a UUID idempotency_key. Reuse the same key and arguments for retries. Read the approval flow.

Request contract

Input parameters

product_idintegerrequired
briefstring
goalstring
tonestring
audiencestring
content_typesarray
format_idstring
platformstring
"instagram""tiktok""social"
slide_countinteger
aspect_ratiostring
"9:16""4:5""3:4"
cta_textstring
cta_asset_idinteger
idempotency_keystringrequired

A new UUID per intended action. Reuse exactly for retries; never reuse with different arguments.

Exact JSON schemas

These are the schemas exported by the Caroush MCP server.

Input schema · JSON
{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": 1
    },
    "brief": {
      "type": "string",
      "maxLength": 1200
    },
    "goal": {
      "type": "string",
      "maxLength": 80
    },
    "tone": {
      "type": "string",
      "maxLength": 80
    },
    "audience": {
      "type": "string",
      "maxLength": 15029
    },
    "content_types": {
      "type": "array",
      "maxItems": 12,
      "items": {
        "type": "string",
        "maxLength": 160
      }
    },
    "format_id": {
      "type": "string",
      "maxLength": 100
    },
    "platform": {
      "type": "string",
      "enum": [
        "instagram",
        "tiktok",
        "social"
      ]
    },
    "slide_count": {
      "type": "integer",
      "minimum": 3,
      "maximum": 10
    },
    "aspect_ratio": {
      "type": "string",
      "enum": [
        "9:16",
        "4:5",
        "3:4"
      ]
    },
    "cta_text": {
      "type": "string",
      "maxLength": 160
    },
    "cta_asset_id": {
      "type": "integer",
      "minimum": 1
    },
    "idempotency_key": {
      "type": "string",
      "format": "uuid",
      "description": "A new UUID per intended action. Reuse exactly for retries; never reuse with different arguments."
    }
  },
  "required": [
    "product_id",
    "idempotency_key"
  ],
  "additionalProperties": false
}

Read the actual outcome

A successful handler response does not necessarily mean generation or publication is finished. Follow the returned operation, native run or schedule status. Results and job states

Back to all 49 tools