Skip to main content
POST
/
v3
/
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
​
webhook
WebhookConfig · object
required

Webhook configuration for receiving processing results

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