AUTOMATION
create_automation
Create a draft generation automation using an existing product and connected accounts. Does not enable or run it. UGC requires cta_asset_id referencing an owned 3–15 second stored video; carousel accepts an optional stored image CTA.
Mutationcreate:automations
Take the docs with youMarkdown for your editor or agent.
TransportStreamable HTTP
Method
tools/callExecutionImmediate 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
kindstringrequired"video""carousel"configurationobjectrequiredSee the full input schema for nested fields and validation rules.
cta_asset_idintegeridempotency_keystringrequiredA 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.
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"video",
"carousel"
]
},
"configuration": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"product_id": {
"type": "integer",
"minimum": 1
},
"social_account_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 30,
"uniqueItems": true,
"minItems": 1
},
"times": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$"
}
},
"timezone": {
"type": "string",
"maxLength": 100
},
"type": {
"type": "string",
"enum": [
"grid-video",
"fade-video",
"ugc-video"
]
},
"template_id": {
"type": "string",
"enum": [
"2x2-grid",
"single-fade",
"ugc-video"
]
},
"scene_pool_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 30,
"uniqueItems": true
},
"music_pool_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 30,
"uniqueItems": true
},
"format_id": {
"type": "string",
"maxLength": 100
},
"slide_count": {
"type": "integer",
"minimum": 3,
"maximum": 10
},
"aspect_ratio": {
"type": "string",
"enum": [
"4:5",
"3:4",
"9:16"
]
},
"settings": {
"type": "object",
"properties": {
"brief": {
"type": "string",
"maxLength": 1200
},
"goal": {
"type": "string",
"maxLength": 80
},
"tone": {
"type": "string",
"maxLength": 80
},
"audience": {
"type": "string",
"maxLength": 120
},
"cta_text": {
"type": "string",
"maxLength": 160
},
"topics": {
"type": "array",
"items": {
"type": "string",
"maxLength": 160
},
"maxItems": 30
},
"cta": {
"type": "string",
"maxLength": 100
},
"language": {
"type": "string",
"maxLength": 60
},
"max_hashtags": {
"type": "integer",
"minimum": 0,
"maximum": 30
},
"duration": {
"type": "integer",
"enum": [
8,
12,
15
]
},
"fade_speed": {
"type": "string",
"enum": [
"normal",
"fast",
"faster"
]
},
"volume": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"presenter_ids": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"maxLength": 100
}
},
"text_template": {
"type": "string",
"maxLength": 60
},
"text_y": {
"type": "integer",
"minimum": 15,
"maximum": 85
},
"text_size": {
"type": "integer"
},
"original_audio": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"name",
"product_id",
"social_account_ids",
"times"
],
"additionalProperties": false
},
"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": [
"kind",
"configuration",
"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