Sign in

v1

latestOpenAPI 3.0.02026-07-26300209.6 KB
Automation

Start multiple automations asynchronously

Creates and enqueues multiple automation runs in a single request, returning run_ids immediately without waiting for completion. Maximum 100 runs per request.

Atomic creation: Run creation is all-or-nothing. Either all runs are created successfully, or none are (returns error).

Idempotency: This endpoint does not currently support idempotency keys. Retrying a failed request may create duplicate runs.

post/v1/automation/run-batch

Request body

profile_idstring

Browser Context Profile ID to use when use_profile is true.

output_schemaobject

Optional provider-supported structured-output schema subset applied to every run in the batch. Unsupported fields are rejected before the request is accepted.

Example request

{
  "runs": [
    {
      "url": "https://example.com",
      "goal": "Find the pricing page and extract all plan details",
      "browser_profile": "lite",
      "api_integration": "dify",
      "agent_config": {
        "mode": "strict",
        "cursor_style": "standard",
        "max_steps": 50,
        "max_duration_seconds": 300
      },
      "use_vault": true,
      "use_profile": true,
      "credential_item_ids": [
        "cred:conn-abc:Work:item-123",
        "cred:conn-def:Personal:item-456"
      ],
      "proxy_config": {
        "enabled": true,
        "country_code": "US"
      }
    }
  ],
  "profile_id": "prof_abc123def4567890",
  "output_schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "price": {
        "type": "number"
      }
    },
    "required": [
      "title",
      "price"
    ]
  }
}

Response

All runs created and enqueued successfully.

run_idsstring[] nullable required

Created run IDs. Null if creation failed.

Example response

{
  "run_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f23456789012"
  ],
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}