Skip to main content
POST
/
v1
/
documents
/
analyze
curl --request POST \
  --url https://api.traddocs.com/v1/documents/analyze \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file=@your/path/sample.pdf \
  --form url=https://url_to_your_document.pdf

[
  {
    "split": {
      "document_type": "<string>",
      "pages": [
        123
      ]
    },
    "extracted": {}
  }
]

​
Analyze Document Endpoint

The Analyze Document endpoint processes and analyzes multiple documents to extract important information. Here’s a detailed breakdown of its functionality:
  1. Document Splitting: The endpoint splits the provided documents into the appropriate types using a document splitter.
  2. Information Extraction: The endpoint extracts key-value pairs of important information from each split document.

​
Supported document types

curl --request POST \
  --url https://api.traddocs.com/v1/documents/analyze \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file=@your/path/sample.pdf \
  --form url=https://url_to_your_document.pdf

Authorizations

​
x-api-key
string
header
required

Body

multipart/form-data

Represents a request for document analysis. The object can contain either a file or a URL pointing to the document to be analyzed. The properties are mutually exclusive, meaning you should provide either a file or a URL, but not both.

​
file
file

A binary file representing the document to be analyzed. This should be provided as a file upload, for example using a multipart/form-data request. The file can be in various formats such as .pdf, .docx, .eml, etc. Example usage: -F 'files=@path/to/your-document.extension'.

​
url
string<uri>

A URI pointing to the document to be analyzed. This should be used if the document is hosted at a specific URL and can be accessed directly from the web.

Minimum string length: 1

Response

Successful Response

​
split
object

Details of how the document has been split into its respective type and the associated pages.

​
extracted
object

The key-value pairs of essential information extracted from the document.