Skip to main content
POST
/
v1
/
automation
/
run-batch
Start multiple automations asynchronously
curl --request POST \
  --url https://agent.tinyfish.ai/v1/automation/run-batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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
      },
      "capture_config": {
        "elements": true,
        "snapshots": true,
        "screenshots": true,
        "recording": true
      },
      "webhook_url": "<string>",
      "use_vault": true,
      "use_profile": true,
      "credential_item_ids": [
        "cred:conn-abc:Work:item-123",
        "cred:conn-def:Personal:item-456"
      ]
    }
  ],
  "output_schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "price": {
        "type": "number"
      }
    },
    "required": [
      "title",
      "price"
    ]
  }
}
'
{
  "run_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f23456789012"
  ],
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.tinyfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Body

application/json

Batch of automation task configurations

​
runs
object[]
required

Array of run configurations (1-100)

Required array length: 1 - 100 elements
​
output_schema
object

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

Example:
{
  "type": "object",
  "properties": {
    "title": { "type": "string" },
    "price": { "type": "number" }
  },
  "required": ["title", "price"]
}

Response

All runs created and enqueued successfully.

Batch async run response. Run creation is atomic. Returns run_ids on success, error on failure.

​
run_ids
string[] | null
required

Created run IDs. Null if creation failed.

Example:
[
  "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "b2c3d4e5-f6a7-8901-bcde-f23456789012"
]
​
error
object
required

Error details. Null if successful.