Create batch tasks

Create batch async tasks

curl --request POST \
  --url https://api.cloro.dev/v1/async/task/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "taskType": "CHATGPT",
    "priority": 5,
    "idempotencyKey": "batch-chatgpt-001",
    "webhook": {
      "url": "https://your-app.com/webhook-handler"
    },
    "payload": {
      "prompt": "What do you know about Acme Corp?",
      "country": "US"
    }
  },
  {
    "taskType": "AIMODE",
    "priority": 3,
    "idempotencyKey": "batch-aimode-001",
    "payload": {
      "prompt": "Latest news about Acme Corp",
      "country": "US"
    }
  }
]
'

import requests

url = "https://api.cloro.dev/v1/async/task/batch"

payload = [
    {
        "taskType": "CHATGPT",
        "priority": 5,
        "idempotencyKey": "batch-chatgpt-001",
        "webhook": { "url": "https://your-app.com/webhook-handler" },
        "payload": {
            "prompt": "What do you know about Acme Corp?",
            "country": "US"
        }
    },
    {
        "taskType": "AIMODE",
        "priority": 3,
        "idempotencyKey": "batch-aimode-001",
        "payload": {
            "prompt": "Latest news about Acme Corp",
            "country": "US"
        }
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      taskType: 'CHATGPT',
      priority: 5,
      idempotencyKey: 'batch-chatgpt-001',
      webhook: {url: 'https://your-app.com/webhook-handler'},
      payload: {prompt: 'What do you know about Acme Corp?', country: 'US'}
    },
    {
      taskType: 'AIMODE',
      priority: 3,
      idempotencyKey: 'batch-aimode-001',
      payload: {prompt: 'Latest news about Acme Corp', country: 'US'}
    }
  ])
};

fetch('https://api.cloro.dev/v1/async/task/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloro.dev/v1/async/task/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'taskType' => 'CHATGPT',
        'priority' => 5,
        'idempotencyKey' => 'batch-chatgpt-001',
        'webhook' => [
                'url' => 'https://your-app.com/webhook-handler'
        ],
        'payload' => [
                'prompt' => 'What do you know about Acme Corp?',
                'country' => 'US'
        ]
    ],
    [
        'taskType' => 'AIMODE',
        'priority' => 3,
        'idempotencyKey' => 'batch-aimode-001',
        'payload' => [
                'prompt' => 'Latest news about Acme Corp',
                'country' => 'US'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloro.dev/v1/async/task/batch"

	payload := strings.NewReader("[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cloro.dev/v1/async/task/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloro.dev/v1/async/task/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "summary": {
    "total": 3,
    "succeeded": 2,
    "failed": 1
  },
  "results": [
    {
      "success": true,
      "index": 0,
      "task": {
        "id": "b27a21e1-7c39-4aa2-a347-23e828c426f9",
        "taskType": "CHATGPT",
        "status": "QUEUED",
        "priority": 1,
        "createdAt": "2026-04-09T15:00:00.000Z",
        "latencyMs": null,
        "idempotencyKey": "batch-chatgpt-001"
      },
      "credits": {
        "creditsToCharge": 5,
        "creditsCharged": null
      }
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": [
      {
        "field": "prompt",
        "message": "Prompt cannot be empty"
      }
    ],
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing or invalid API key",
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "QUEUE_LIMIT_EXCEEDED",
    "message": "Queue limit exceeded. Maximum 100000 queued tasks allowed per organization",
    "timestamp": "2026-04-09T15:00:00.000Z",
    "details": {
      "limit": 100000
    }
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Maximum retries exceeded",
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

POST

async

task

batch

Create batch async tasks

curl --request POST \
  --url https://api.cloro.dev/v1/async/task/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "taskType": "CHATGPT",
    "priority": 5,
    "idempotencyKey": "batch-chatgpt-001",
    "webhook": {
      "url": "https://your-app.com/webhook-handler"
    },
    "payload": {
      "prompt": "What do you know about Acme Corp?",
      "country": "US"
    }
  },
  {
    "taskType": "AIMODE",
    "priority": 3,
    "idempotencyKey": "batch-aimode-001",
    "payload": {
      "prompt": "Latest news about Acme Corp",
      "country": "US"
    }
  }
]
'

import requests

url = "https://api.cloro.dev/v1/async/task/batch"

payload = [
    {
        "taskType": "CHATGPT",
        "priority": 5,
        "idempotencyKey": "batch-chatgpt-001",
        "webhook": { "url": "https://your-app.com/webhook-handler" },
        "payload": {
            "prompt": "What do you know about Acme Corp?",
            "country": "US"
        }
    },
    {
        "taskType": "AIMODE",
        "priority": 3,
        "idempotencyKey": "batch-aimode-001",
        "payload": {
            "prompt": "Latest news about Acme Corp",
            "country": "US"
        }
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      taskType: 'CHATGPT',
      priority: 5,
      idempotencyKey: 'batch-chatgpt-001',
      webhook: {url: 'https://your-app.com/webhook-handler'},
      payload: {prompt: 'What do you know about Acme Corp?', country: 'US'}
    },
    {
      taskType: 'AIMODE',
      priority: 3,
      idempotencyKey: 'batch-aimode-001',
      payload: {prompt: 'Latest news about Acme Corp', country: 'US'}
    }
  ])
};

fetch('https://api.cloro.dev/v1/async/task/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloro.dev/v1/async/task/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'taskType' => 'CHATGPT',
        'priority' => 5,
        'idempotencyKey' => 'batch-chatgpt-001',
        'webhook' => [
                'url' => 'https://your-app.com/webhook-handler'
        ],
        'payload' => [
                'prompt' => 'What do you know about Acme Corp?',
                'country' => 'US'
        ]
    ],
    [
        'taskType' => 'AIMODE',
        'priority' => 3,
        'idempotencyKey' => 'batch-aimode-001',
        'payload' => [
                'prompt' => 'Latest news about Acme Corp',
                'country' => 'US'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloro.dev/v1/async/task/batch"

	payload := strings.NewReader("[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cloro.dev/v1/async/task/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloro.dev/v1/async/task/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"taskType\": \"CHATGPT\",\n    \"priority\": 5,\n    \"idempotencyKey\": \"batch-chatgpt-001\",\n    \"webhook\": {\n      \"url\": \"https://your-app.com/webhook-handler\"\n    },\n    \"payload\": {\n      \"prompt\": \"What do you know about Acme Corp?\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"taskType\": \"AIMODE\",\n    \"priority\": 3,\n    \"idempotencyKey\": \"batch-aimode-001\",\n    \"payload\": {\n      \"prompt\": \"Latest news about Acme Corp\",\n      \"country\": \"US\"\n    }\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "summary": {
    "total": 3,
    "succeeded": 2,
    "failed": 1
  },
  "results": [
    {
      "success": true,
      "index": 0,
      "task": {
        "id": "b27a21e1-7c39-4aa2-a347-23e828c426f9",
        "taskType": "CHATGPT",
        "status": "QUEUED",
        "priority": 1,
        "createdAt": "2026-04-09T15:00:00.000Z",
        "latencyMs": null,
        "idempotencyKey": "batch-chatgpt-001"
      },
      "credits": {
        "creditsToCharge": 5,
        "creditsCharged": null
      }
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": [
      {
        "field": "prompt",
        "message": "Prompt cannot be empty"
      }
    ],
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing or invalid API key",
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "QUEUE_LIMIT_EXCEEDED",
    "message": "Queue limit exceeded. Maximum 100000 queued tasks allowed per organization",
    "timestamp": "2026-04-09T15:00:00.000Z",
    "details": {
      "limit": 100000
    }
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Maximum retries exceeded",
    "timestamp": "2025-01-15T12:00:00.000Z"
  }
}

Submit up to 500 async tasks in a single HTTP request instead of one API call per task. Each task accepts the same fields as a single async task: taskType, payload, and optionally priority, idempotencyKey, and webhook.

Partial success: each task is validated independently, so one invalid task does not block the others.
Per-task results: the response includes a results array with success or failure details for each task, preserving the original input order by index.
Per-task webhook delivery: each task fires its own webhook as soon as it completes — you don’t wait for the full batch. Webhooks arrive in completion order, not submission order.

For submitting a single task, see the async requests guide.

Request constraints

Constraint	Value
Minimum tasks per request	1
Maximum tasks per request	500

The queue check is all-or-nothing and runs before any task is processed: if the batch would push your organization past its queue limit, the whole batch is rejected with 429 QUEUE_LIMIT_EXCEEDED. A body that is not a JSON array of 1-500 tasks gets 400 VALIDATION_ERROR instead, also before any task is processed.

Per-task error codes

When a task fails validation within a batch, its result includes one of these error codes:

Code	Description
`VALIDATION_ERROR`	The task failed schema validation. `details` includes field-level errors.
`RESOURCE_ALREADY_EXISTS`	The `idempotencyKey` was already used (either in a previous request or earlier in the same batch). When a previous request used it, `details.taskId` is the ID of that task.
`INSUFFICIENT_CREDITS`	Not enough credits remaining for this task. Credits are tracked per task within the batch.
`MODEL_UNAVAILABLE`	The `taskType` is not available, for example `GROK`, `PERPLEXITY` or `COPILOT`, which are discontinued. The task was not created.

Example usage

Submit a batch of tasks

curl -X POST "https://api.cloro.dev/v1/async/task/batch" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "taskType": "CHATGPT",
      "priority": 5,
      "idempotencyKey": "batch-chatgpt-001",
      "webhook": {
        "url": "https://your-app.com/webhook-handler"
      },
      "payload": {
        "prompt": "What do you know about Acme Corp?",
        "country": "US"
      }
    },
    {
      "taskType": "AIMODE",
      "priority": 3,
      "idempotencyKey": "batch-aimode-001",
      "payload": {
        "prompt": "Latest news about Acme Corp",
        "country": "US"
      }
    },
    {
      "taskType": "GEMINI",
      "payload": {
        "prompt": "Summarize Acme Corp recent announcements",
        "country": "US"
      }
    }
  ]'

import axios from 'axios';

const apiKey = 'YOUR_API_KEY';
const url = 'https://api.cloro.dev/v1/async/task/batch';

const tasks = [
  {
    taskType: 'CHATGPT',
    priority: 5,
    idempotencyKey: 'batch-chatgpt-001',
    webhook: { url: 'https://your-app.com/webhook-handler' },
    payload: { prompt: 'What do you know about Acme Corp?', country: 'US' },
  },
  {
    taskType: 'AIMODE',
    priority: 3,
    idempotencyKey: 'batch-aimode-001',
    payload: { prompt: 'Latest news about Acme Corp', country: 'US' },
  },
  {
    taskType: 'GEMINI',
    payload: { prompt: 'Summarize Acme Corp recent announcements', country: 'US' },
  },
];

try {
  const response = await axios.post(url, tasks, {
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json',
    },
  });

  const { summary, results } = response.data;
  console.log(`Batch complete: ${summary.succeeded} succeeded, ${summary.failed} failed`);

  for (const result of results) {
    if (result.success) {
      console.log(`Task ${result.index}: ${result.task.id} (${result.task.taskType})`);
    } else {
      console.error(`Task ${result.index} failed: ${result.error.code} - ${result.error.message}`);
    }
  }
} catch (error) {
  console.error('Batch request failed:', error.response?.data || error.message);
}

import requests

api_key = 'YOUR_API_KEY'
url = 'https://api.cloro.dev/v1/async/task/batch'

tasks = [
    {
        "taskType": "CHATGPT",
        "priority": 5,
        "idempotencyKey": "batch-chatgpt-001",
        "webhook": {"url": "https://your-app.com/webhook-handler"},
        "payload": {"prompt": "What do you know about Acme Corp?", "country": "US"},
    },
    {
        "taskType": "AIMODE",
        "priority": 3,
        "idempotencyKey": "batch-aimode-001",
        "payload": {"prompt": "Latest news about Acme Corp", "country": "US"},
    },
    {
        "taskType": "GEMINI",
        "payload": {"prompt": "Summarize Acme Corp recent announcements", "country": "US"},
    },
]

response = requests.post(
    url,
    json=tasks,
    headers={
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json",
    },
)

data = response.json()
summary = data["summary"]
print(f"Batch complete: {summary['succeeded']} succeeded, {summary['failed']} failed")

for result in data["results"]:
    if result["success"]:
        task = result["task"]
        print(f"Task {result['index']}: {task['id']} ({task['taskType']})")
    else:
        error = result["error"]
        print(f"Task {result['index']} failed: {error['code']} - {error['message']}")

Response with partial success

{
  "success": true,
  "summary": {
    "total": 3,
    "succeeded": 2,
    "failed": 1
  },
  "results": [
    {
      "success": true,
      "index": 0,
      "task": {
        "id": "a16f10d0-6b28-4991-9236-12d717b315e8",
        "taskType": "CHATGPT",
        "status": "QUEUED",
        "priority": 5,
        "createdAt": "2026-04-09T15:00:00.000Z",
        "latencyMs": null,
        "idempotencyKey": "batch-chatgpt-001"
      },
      "credits": {
        "creditsToCharge": 5,
        "creditsCharged": null
      }
    },
    {
      "success": true,
      "index": 1,
      "task": {
        "id": "c38b32f2-8d40-5bb3-b458-34f939d537e0",
        "taskType": "AIMODE",
        "status": "QUEUED",
        "priority": 3,
        "createdAt": "2026-04-09T15:00:00.000Z",
        "latencyMs": null,
        "idempotencyKey": "batch-aimode-001"
      },
      "credits": {
        "creditsToCharge": 4,
        "creditsCharged": null
      }
    },
    {
      "success": false,
      "index": 2,
      "error": {
        "code": "INSUFFICIENT_CREDITS",
        "message": "Insufficient credits",
        "timestamp": "2026-04-09T15:00:00.000Z"
      }
    }
  ]
}

Handling partial failures

Resubmit only INSUFFICIENT_CREDITS tasks, after you top up: they were never created, so their original idempotencyKey is still free. A VALIDATION_ERROR task fails again until you fix its payload, and giving a RESOURCE_ALREADY_EXISTS task a new key creates a duplicate that is charged again.

const retry = results
  .filter((r) => !r.success && r.error.code === 'INSUFFICIENT_CREDITS')
  .map((r) => tasks[r.index]);

if (retry.length > 0) {
  await axios.post(url, retry, {
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json',
    },
  });
}

Authorizations

Authorization

string

header

required

cloro API key as a bearer token. One key grants every endpoint in this spec; per-key scopes are not available, so a client cannot request a narrower permission. Keys are created and revoked in the dashboard.

Body

application/json

Required array length: 1 - 500 elements

taskType

enum<string>

required

The AI provider to use for this task.

Available options:

AIMODE,

BING_AIMODE,

GOOGLE,

GOOGLE_NEWS,

GOOGLE_PRODUCT,

GEMINI,

CHATGPT

Example:

"CHATGPT"

payload

object

required

The provider's request body, validated against the same schema as its sync endpoint (for example ChatGPTMonitorRequest). That makes country required here too, or gl on the Google endpoints. For GOOGLE_PRODUCT, send only productResultToken.

Example:

{
  "prompt": "What do you know about Acme Corp?",
  "country": "US"
}

priority

integer

default:1

Task priority level (1-10). Higher numbers are processed first. Defaults to 1.

Required range: 1 <= x <= 10

Example:

5

idempotencyKey

string

Unique string to prevent duplicate task creation. Must be unique across your account.

Example:

"batch-chatgpt-001"

webhook

object

Webhook configuration for task completion notification.

Show child attributes

Response

Batch processed. Check the summary and individual results for per-task success or failure.

success

boolean

required

Always true for a successfully processed batch (individual tasks may still fail).

Example:

true

summary

object

required

Aggregate counts for the batch.

Show child attributes

results

object[]

required

Per-task results preserving the original input order by index.

Option 1
Option 2

Show child attributes

Overview

ChatGPT

Google

Google AI Mode

Bing AI Mode

Gemini

Google News

Async tasks

Utilities

Create batch tasks

Request constraints

Per-task error codes

Example usage

Submit a batch of tasks

Response with partial success

Handling partial failures

Authorizations

Body

Response