Endpoints

Process (sync)

Send one or more documents for processing and wait for the result.

The request blocks until processing completes and returns the extracted data directly in the response.

Request body

documents (required): Array of document objects. Each document must have a type field (url, base64, or text).
metadata (optional): Custom key-value object stored with the result.

Response fields

entry_id: Unique identifier for this result.
resource_type: Always "structure".
resource_id: The structure used for extraction.
resource_version_number: The version of the structure applied.
data: The extracted data as structured JSON.
errors: Validation errors, if any. null when everything is correct.
status: completed, completed_with_errors, or failed.
time_ms: Processing time in milliseconds.
price: Cost of this request.

POST

deployments

{deployment_id}

Process (sync)

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

{
  "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_version_number": 123,
  "data": {},
  "status": "<string>",
  "resource_type": "structure",
  "errors": [
    {}
  ],
  "time_ms": 123,
  "price": 123
}

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 synchronous document processing via deployment.

documents

(DocumentInputText · object | DocumentInputURL · object | DocumentInputBase64 · object | DocumentInputId · object)[]

required

List of documents to process (text, url, base64, or id of pre-uploaded document)

Minimum array length: 1

Direct text content for processing.

DocumentInputText
DocumentInputURL
DocumentInputBase64
DocumentInputId

Show child attributes

metadata

Metadata · object

Optional client-provided metadata. Stored with the entry for correlation.

Response

Successful Response

Unified response for synchronous processing.

entry_id

string<uuid>

required

Unique identifier for the created entry

resource_id

string<uuid>

required

ID of the structure used

resource_version_number

integer

required

Version number of the structure used

data

Data · object

required

Processed data

status

string

required

Processing status: completed, completed_with_errors, or failed

resource_type

string

default:structure

Type of resource processed

errors

Errors · object[] | null

Processing or validation errors

time_ms

integer | null

Processing time in milliseconds

price

number | null

Processing cost

Process (async)Send one or more documents for processing and receive the result later via webhook. Returns immediately with an `entry_id` and `status: "pending"`. When processing completes, Matil sends a POST request to your webhook URL with the result. ## Request body - `documents` (required): Array of document objects. - `webhook` (required): Object with `url` (your endpoint), `secret` (optional, for HMAC signature verification), and `incremental` (optional, defaults to `true`). - `metadata` (optional): Custom key-value object stored with the result. ## Webhook events - `structurer.completed`: Processing succeeded. Payload contains the extracted data. - `structurer.failed`: Processing failed. Payload contains error details.

Process (sync)

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

{
  "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_version_number": 123,
  "data": {},
  "status": "<string>",
  "resource_type": "structure",
  "errors": [
    {}
  ],
  "time_ms": 123,
  "price": 123
}

Documentation Index

Authorizations

Headers

Path Parameters

Body

Response