Extract Custom Metadata

curl --request POST \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_id": "<string>",
  "json_schema": {
    "anyOf": [
      "<unknown>"
    ],
    "title": "<unknown>",
    "description": "<string>",
    "enum": [
      "<string>"
    ],
    "properties": {},
    "items": null,
    "$defs": {},
    "pattern": "<string>",
    "required": [
      "<string>"
    ]
  },
  "llm_model_prefix": "gemini-2.5-pro",
  "attachment_filters": [
    {
      "name": "<string>",
      "id": "<string>",
      "mime_type": "<string>"
    }
  ],
  "sources": [
    {
      "type": "description"
    }
  ],
  "instruction": "<string>",
  "provide_location": false,
  "integer_decimal_handling": "error"
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom"

payload = {
    "document_id": "<string>",
    "json_schema": {
        "anyOf": ["<unknown>"],
        "title": "<unknown>",
        "description": "<string>",
        "enum": ["<string>"],
        "properties": {},
        "items": None,
        "$defs": {},
        "pattern": "<string>",
        "required": ["<string>"]
    },
    "llm_model_prefix": "gemini-2.5-pro",
    "attachment_filters": [
        {
            "name": "<string>",
            "id": "<string>",
            "mime_type": "<string>"
        }
    ],
    "sources": [{ "type": "description" }],
    "instruction": "<string>",
    "provide_location": False,
    "integer_decimal_handling": "error"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document_id: '<string>',
    json_schema: {
      anyOf: ['<unknown>'],
      title: '<unknown>',
      description: '<string>',
      enum: ['<string>'],
      properties: {},
      items: null,
      $defs: {},
      pattern: '<string>',
      required: ['<string>']
    },
    llm_model_prefix: 'gemini-2.5-pro',
    attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
    sources: [{type: 'description'}],
    instruction: '<string>',
    provide_location: false,
    integer_decimal_handling: 'error'
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom",
  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([
    'document_id' => '<string>',
    'json_schema' => [
        'anyOf' => [
                '<unknown>'
        ],
        'title' => '<unknown>',
        'description' => '<string>',
        'enum' => [
                '<string>'
        ],
        'properties' => [
                
        ],
        'items' => null,
        '$defs' => [
                
        ],
        'pattern' => '<string>',
        'required' => [
                '<string>'
        ]
    ],
    'llm_model_prefix' => 'gemini-2.5-pro',
    'attachment_filters' => [
        [
                'name' => '<string>',
                'id' => '<string>',
                'mime_type' => '<string>'
        ]
    ],
    'sources' => [
        [
                'type' => 'description'
        ]
    ],
    'instruction' => '<string>',
    'provide_location' => false,
    'integer_decimal_handling' => 'error'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

assistant

api

tenants

{tenant}

metadata:extractCustom

Extract Custom Metadata

curl --request POST \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_id": "<string>",
  "json_schema": {
    "anyOf": [
      "<unknown>"
    ],
    "title": "<unknown>",
    "description": "<string>",
    "enum": [
      "<string>"
    ],
    "properties": {},
    "items": null,
    "$defs": {},
    "pattern": "<string>",
    "required": [
      "<string>"
    ]
  },
  "llm_model_prefix": "gemini-2.5-pro",
  "attachment_filters": [
    {
      "name": "<string>",
      "id": "<string>",
      "mime_type": "<string>"
    }
  ],
  "sources": [
    {
      "type": "description"
    }
  ],
  "instruction": "<string>",
  "provide_location": false,
  "integer_decimal_handling": "error"
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom"

payload = {
    "document_id": "<string>",
    "json_schema": {
        "anyOf": ["<unknown>"],
        "title": "<unknown>",
        "description": "<string>",
        "enum": ["<string>"],
        "properties": {},
        "items": None,
        "$defs": {},
        "pattern": "<string>",
        "required": ["<string>"]
    },
    "llm_model_prefix": "gemini-2.5-pro",
    "attachment_filters": [
        {
            "name": "<string>",
            "id": "<string>",
            "mime_type": "<string>"
        }
    ],
    "sources": [{ "type": "description" }],
    "instruction": "<string>",
    "provide_location": False,
    "integer_decimal_handling": "error"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document_id: '<string>',
    json_schema: {
      anyOf: ['<unknown>'],
      title: '<unknown>',
      description: '<string>',
      enum: ['<string>'],
      properties: {},
      items: null,
      $defs: {},
      pattern: '<string>',
      required: ['<string>']
    },
    llm_model_prefix: 'gemini-2.5-pro',
    attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
    sources: [{type: 'description'}],
    instruction: '<string>',
    provide_location: false,
    integer_decimal_handling: 'error'
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom",
  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([
    'document_id' => '<string>',
    'json_schema' => [
        'anyOf' => [
                '<unknown>'
        ],
        'title' => '<unknown>',
        'description' => '<string>',
        'enum' => [
                '<string>'
        ],
        'properties' => [
                
        ],
        'items' => null,
        '$defs' => [
                
        ],
        'pattern' => '<string>',
        'required' => [
                '<string>'
        ]
    ],
    'llm_model_prefix' => 'gemini-2.5-pro',
    'attachment_filters' => [
        [
                'name' => '<string>',
                'id' => '<string>',
                'mime_type' => '<string>'
        ]
    ],
    'sources' => [
        [
                'type' => 'description'
        ]
    ],
    'instruction' => '<string>',
    'provide_location' => false,
    'integer_decimal_handling' => 'error'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/metadata:extractCustom")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_id\": \"<string>\",\n  \"json_schema\": {\n    \"anyOf\": [\n      \"<unknown>\"\n    ],\n    \"title\": \"<unknown>\",\n    \"description\": \"<string>\",\n    \"enum\": [\n      \"<string>\"\n    ],\n    \"properties\": {},\n    \"items\": null,\n    \"$defs\": {},\n    \"pattern\": \"<string>\",\n    \"required\": [\n      \"<string>\"\n    ]\n  },\n  \"llm_model_prefix\": \"gemini-2.5-pro\",\n  \"attachment_filters\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ],\n  \"sources\": [\n    {\n      \"type\": \"description\"\n    }\n  ],\n  \"instruction\": \"<string>\",\n  \"provide_location\": false,\n  \"integer_decimal_handling\": \"error\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant

string | null

required

The domain of the customer

Example:

"example.com"

Body

application/json

document_id

string

required

The document ID of the files

json_schema

OpenAISchema · object

required

The metadata schema to be extracted. It is the OpenAI supported subset of the JSON schema. The additional_properties and required fields are automatically generated so their value is ignored.

Show child attributes

llm_provider

enum<string> | null

The LLM provider to use. If not provided, the default provider will be used.

Available options:

OpenAI,

Google,

Altirnao,

MistralAI,

Anthropic

llm_model_prefix

string | null

The prefix of the LLM model name to use. If not provided, the default model will be used.

Example:

"gemini-2.5-pro"

attachment_filters

AttachmentFilter · object[] | null

deprecated

The attachments to extract metadata from. If provided then only the attachments matching one of the rules are used. If not provided then all attachments will be extracted. Deprecated: use sources with an attachments entry instead.

Show child attributes

sources

(DescriptionExtractionSource · object | AttachmentsExtractionSource · object)[] | null

The ordered document content sources to extract metadata from. If omitted, attachment-only extraction is used for backward compatibility. Description sources are opt-in.

Minimum array length: 1

DescriptionExtractionSource
AttachmentsExtractionSource

Show child attributes

instruction

string | null

The prompt extension for the metadata extraction

provide_location

boolean

default:false

Whether to calculate and return page locations (bounding boxes) for the quote supporting each extracted field. Quotes are matched against textual and scanned PDF attachments plus PNG, JPEG, and WebP images without changing extracted values. Unsupported attachment types and quotes that do not occur verbatim after normalization do not produce boxes.

integer_decimal_handling

enum<string>

default:error

How to coerce a decimal value the LLM returns for any integer-typed field in the schema: truncate drops the fractional part (3.7 → 3), round rounds to the nearest integer (3.5 → 4, 3.4 → 3), roundup always rounds up toward positive infinity (3.2 → 4), error raises an extraction error (default — current behavior). Applies uniformly to all integer fields in the JSON schema.

Available options:

truncate,

round,

roundup,

error

Response

Successful Response

The response is of type Response Extract Custom Metadata Assistant Api V1 Tenants Tenant Metadata Extractcustom Post · object.