> ## Documentation Index
> Fetch the complete documentation index at: https://apixo.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# APiXO MCP Batch Integration: Submit, Query, and Verify Webhooks

> Use APiXO MCP to read the batch integration guide, submit asynchronous batches, query batch status, and understand signed webhook delivery.

APiXO MCP supports two kinds of batch capability:

* A **read-only integration guide** that explains the full batch and signed-webhook lifecycle without requiring a credential.
* API-key tools that submit a batch or query a batch that belongs to the configured API key account.

## Read the guide first

Use `apixo_get_batch_integration_guide` before asking an agent to implement batch processing.

```json theme={null}
{
  "section": "all"
}
```

Select one section when you need a focused answer:

| Section    | Includes                                                                             |
| ---------- | ------------------------------------------------------------------------------------ |
| `overview` | End-to-end lifecycle, limits, states, and public documentation links.                |
| `generate` | Batch request shape, idempotency, item handling, and response fields.                |
| `status`   | Batch reconciliation and independent `taskId` status queries.                        |
| `webhooks` | Secret lifecycle, signed headers, raw-body verification, retries, and deduplication. |

The guide never submits a task, reads account data, or returns a webhook secret.

## Submit a batch

Use `apixo_submit_batch` after your agent has validated the model input with `apixo_get_model_schema`.

```json theme={null}
{
  "model": "seedream-4-5",
  "idempotency_key": "business-batch-20260916-001",
  "items": [
    {
      "client_item_id": "order-1001",
      "idempotency_key": "order-1001-v1",
      "input": {
        "mode": "text-to-image",
        "prompt": "A paper-cut mountain landscape at sunrise"
      }
    }
  ]
}
```

The tool uses the configured `APIXO_API_KEY` and calls the same [Batch Generate API](/docs/api-reference/batch-generate) as a direct REST integration. It does not invent idempotency keys: supply stable business keys yourself.

## Query a batch or one task

Use `apixo_get_batch_status` with the original model and returned `batchId` to inspect the entire batch. The result includes every `clientItemId`, accepted flag, `taskId`, current state, and terminal public result when available.

Use existing `apixo_get_task_status` with an accepted item's `taskId` when you need to inspect one task independently.

```text theme={null}
submit batch → save batchId and taskId values → get_batch_status for reconciliation
                                             → get_task_status for one item
```

Both tools use the configured API key. The hosted API limits data to batches and tasks that belong to that key's account.

## Webhook boundary

`apixo_submit_batch` accepts an optional root-level `webhook_url`, but MCP does not retrieve, rotate, revoke, or return a signing secret. Set up the secret through the REST API or Dashboard, store it only on your server, then configure `webhook_url` when submitting the batch.

For the complete signing payload, headers, retry schedule, and receiver example, use the `webhooks` guide section or read [Batch Webhooks](/docs/api-reference/batch-webhooks).