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

url = "https://api.matil.ai/v3/deployments/{deployment_id}/async"

payload = {
    "documents": [
        {
            "text": "<string>",
            "type": "text",
            "metadata": {}
        }
    ],
    "webhook": {
        "url": "<string>",
        "secret": "<string>",
        "incremental": True
    },
    "metadata": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    documents: [{text: '<string>', type: 'text', metadata: {}}],
    webhook: {url: '<string>', secret: '<string>', incremental: true},
    metadata: {}
  })
};

fetch('https://api.matil.ai/v3/deployments/{deployment_id}/async', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.matil.ai/v3/deployments/{deployment_id}/async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'documents' => [
        [
                'text' => '<string>',
                'type' => 'text',
                'metadata' => [
                                
                ]
        ]
    ],
    'webhook' => [
        'url' => '<string>',
        'secret' => '<string>',
        'incremental' => true
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.matil.ai/v3/deployments/{deployment_id}/async"

	payload := strings.NewReader("{\n  \"documents\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"text\",\n      \"metadata\": {}\n    }\n  ],\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"secret\": \"<string>\",\n    \"incremental\": true\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.matil.ai/v3/deployments/{deployment_id}/async")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documents\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"text\",\n      \"metadata\": {}\n    }\n  ],\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"secret\": \"<string>\",\n    \"incremental\": true\n  },\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.matil.ai/v3/deployments/{deployment_id}/async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"documents\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"text\",\n      \"metadata\": {}\n    }\n  ],\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"secret\": \"<string>\",\n    \"incremental\": true\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_version_number": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "resource_type": "structure"
}
{
  "error": "DOCUMENT_DOWNLOAD_ERROR",
  "message": "Failed to download document from the provided URL",
  "details": null
}
{
  "error": "AUTHENTICATION_REQUIRED",
  "message": "Authentication required. Provide a valid x-api-key header.",
  "details": null
}
{
  "error": "INSUFFICIENT_CREDITS",
  "message": "Insufficient credits. Top up your balance to continue processing.",
  "details": null
}
{
  "error": "DEPLOYMENT_NOT_FOUND",
  "message": "No valid deployment found for the provided ID.",
  "details": null
}
{
  "error": "VALIDATION_ERROR",
  "message": "A webhook object with a url field is required for async processing.",
  "details": null
}

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

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

List of documents to process

Minimum array length: 1

Direct text content for processing.

webhook
WebhookConfig · object
required

Webhook configuration for receiving results

metadata
Metadata · object | null

Optional client-provided metadata

Response

Successful Response

Response for async processing request creation.

entry_id
string<uuid>
required

ID of the pending entry

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 request was received

status
string
default:pending

Initial status

resource_type
string
default:structure

Type of resource being processed