Skip to main content
POST
/
v3
/
entries
/
{entry_id}
/
correction
Create Entry Correction
curl --request POST \
  --url https://api.matil.ai/v3/entries/{entry_id}/correction \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "data": {},
  "patches": [
    {
      "path": "<string>",
      "value": "<unknown>"
    }
  ],
  "notes": "<string>"
}
'
import requests

url = "https://api.matil.ai/v3/entries/{entry_id}/correction"

payload = {
    "data": {},
    "patches": [
        {
            "path": "<string>",
            "value": "<unknown>"
        }
    ],
    "notes": "<string>"
}
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({data: {}, patches: [{path: '<string>', value: '<unknown>'}], notes: '<string>'})
};

fetch('https://api.matil.ai/v3/entries/{entry_id}/correction', 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/entries/{entry_id}/correction",
  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([
    'data' => [
        
    ],
    'patches' => [
        [
                'path' => '<string>',
                'value' => '<unknown>'
        ]
    ],
    'notes' => '<string>'
  ]),
  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/entries/{entry_id}/correction"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"patches\": [\n    {\n      \"path\": \"<string>\",\n      \"value\": \"<unknown>\"\n    }\n  ],\n  \"notes\": \"<string>\"\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/entries/{entry_id}/correction")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"patches\": [\n    {\n      \"path\": \"<string>\",\n      \"value\": \"<unknown>\"\n    }\n  ],\n  \"notes\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.matil.ai/v3/entries/{entry_id}/correction")

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  \"data\": {},\n  \"patches\": [\n    {\n      \"path\": \"<string>\",\n      \"value\": \"<unknown>\"\n    }\n  ],\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patches_applied": 123
}
{
  "error": "AUTHENTICATION_REQUIRED",
  "message": "Authentication required. Provide a valid x-api-key header.",
  "details": null
}
{
  "error": "ENTRY_NOT_FOUND",
  "message": "Entry not found.",
  "details": null
}
{
  "error": "VALIDATION_ERROR",
  "message": "Provide either data or patches (at least one must be non-empty).",
  "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

entry_id
string<uuid>
required

Body

application/json

Schema for creating a correction.

Supports two correction modes:

  1. Full replacement: Provide complete corrected object in data
  2. Path-based patches: Provide list of field patches in patches

Both can be used together: data provides the base, patches applies updates on top.

data
Data · object | null

Full corrected JSON object (complete replacement mode)

patches
FieldPatch · object[] | null

List of path-based field patches using JSON Pointer syntax (partial update mode)

notes
string | null

Notes or reason for the correction

Response

Successful Response

Response for correction creation.

entry_id
string<uuid>
required

Entry ID that was corrected

patches_applied
integer
required

Number of patches applied