Endpoints

Process (batch)

Submit multiple items for processing in a single request. Each item contains its own documents and optional metadata.

Returns immediately with a batch_id and the total item count. Results are delivered via webhook as items complete.

Request body

requests (required): Array of batch items (max 100). Each item has documents (required) and metadata (optional).
webhook (required): Object with url, secret (optional), and incremental (optional, defaults to true). When incremental is true, a webhook is sent as each item completes. When false, a single webhook is sent when the entire batch finishes.

Webhook events

batch.item.completed: A single item finished processing (incremental mode).
batch.completed: The entire batch finished.
batch.failed: All items in the batch failed.

POST

deployments

{deployment_id}

batch

Process (batch)

curl --request POST \
  --url https://api.matil.ai/v3/deployments/{deployment_id}/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "requests": [
    {
      "documents": [
        {
          "text": "<string>",
          "type": "text",
          "metadata": {}
        }
      ],
      "metadata": {}
    }
  ],
  "webhook": {
    "url": "<string>",
    "secret": "<string>",
    "incremental": true
  }
}
'

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_items": 123,
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_version_number": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "resource_type": "structure"
}

Authorizations

x-api-key

string

header

required

Headers

authorization

string | null

x-api-key

string | null

X-Tenant-ID

string | null

Path Parameters

deployment_id

string<uuid>

required

Body

application/json

Request for batch document processing via deployment.

requests

BatchItem · object[]

required

List of items to process. Each item contains documents and optional metadata.

Required array length: 1 - 100 elements

Show child attributes

webhook

WebhookConfig · object

required

Webhook configuration for receiving processing results

Show child attributes

Response

Successful Response

Response for batch processing request creation.

batch_id

string<uuid>

required

Unique identifier for the batch

total_items

integer

required

Number of items in the batch

resource_id

string<uuid>

required

ID of the structure being processed

resource_version_number

integer

required

Version number of the structure

created_at

string<date-time>

required

When the batch was created

status

string

default:pending

Initial batch status

resource_type

string

default:structure

Type of resource being processed

Get BatchGet the current status and results of a batch processing request. Returns progress information (`total_items`, `completed_items`, `failed_items`), individual item results with their extracted data, and any failed webhook deliveries for debugging.

Process (batch)

curl --request POST \
  --url https://api.matil.ai/v3/deployments/{deployment_id}/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "requests": [
    {
      "documents": [
        {
          "text": "<string>",
          "type": "text",
          "metadata": {}
        }
      ],
      "metadata": {}
    }
  ],
  "webhook": {
    "url": "<string>",
    "secret": "<string>",
    "incremental": true
  }
}
'

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_items": 123,
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_version_number": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "resource_type": "structure"
}

Documentation Index

Authorizations

Headers

Path Parameters

Body

Response