Tool reference/automation

AUTOMATION

delete_automation

Delete an automation after browser approval, cancel unfinished runs and preserve existing published output. Releases reserved credits for unfinished video generation.

Mutationdelete:automationsBrowser approval
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. The user reviews and approves this exact action in Caroush before it runs. Read the approval flow.

Request contract

Input parameters

kindstringrequired
"video""carousel"
automation_idintegerrequired
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": {
    "kind": {
      "type": "string",
      "enum": [
        "video",
        "carousel"
      ]
    },
    "automation_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",
    "automation_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