Tool reference/ai

AI

generate_ugc_hook

Generate one concise on-screen UGC video hook from a creative brief using the same prompt as Studio. Runs asynchronously; returns text only and does not render or publish a video.

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

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

Request contract

Input parameters

briefstringrequired
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": {
    "brief": {
      "type": "string",
      "maxLength": 500
    },
    "idempotency_key": {
      "type": "string",
      "format": "uuid",
      "description": "A new UUID per intended action. Reuse exactly for retries; never reuse with different arguments."
    }
  },
  "required": [
    "brief",
    "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