Skip to main content
POST
/
v3
/
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.

​
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