Generate Extraction Schema

curl -X POST https://api.appliedai.club/api/extractor/v1/generate-schema \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_url": "https://example.com/invoice.pdf"
  }'

import requests
import json

url = "https://api.appliedai.club/api/extractor/v1/generate-schema"
headers = {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "document_url": "https://example.com/invoice.pdf"
}

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

{
  "document_type": "<string>",
  "extraction_schema": {
    "fields": [
      {
        "name": "<string>",
        "description": "<string>",
        "required": false,
        "isExpanded": true,
        "children": [
          "<unknown>"
        ]
      }
    ],
    "document_description": "<string>"
  },
  "confidence": 0.5
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "error_code": "unauthorized"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "<string>",
  "retry_after": 123
}

{
  "detail": "<string>"
}

POST

api

extractor

generate-schema

curl -X POST https://api.appliedai.club/api/extractor/v1/generate-schema \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_url": "https://example.com/invoice.pdf"
  }'

import requests
import json

url = "https://api.appliedai.club/api/extractor/v1/generate-schema"
headers = {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "document_url": "https://example.com/invoice.pdf"
}

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

{
  "document_type": "<string>",
  "extraction_schema": {
    "fields": [
      {
        "name": "<string>",
        "description": "<string>",
        "required": false,
        "isExpanded": true,
        "children": [
          "<unknown>"
        ]
      }
    ],
    "document_description": "<string>"
  },
  "confidence": 0.5
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "error_code": "unauthorized"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "<string>",
  "retry_after": 123
}

{
  "detail": "<string>"
}

This API requires authentication. See our Authentication Guide for details.

Features

Identifies document type (Invoice, PO, etc.)
Generates field schema based on content
Supports PDF and images (jpg, jpeg, png)
Accepts URL or base64-encoded file content
Maximum file size: 10MB

Request Body

document_url

string

URL of the document to analyze

file_content

string

Base64 encoded file content

curl -X POST https://api.appliedai.club/api/extractor/v1/generate-schema \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_url": "https://example.com/invoice.pdf"
  }'

import requests
import json

url = "https://api.appliedai.club/api/extractor/v1/generate-schema"
headers = {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "document_url": "https://example.com/invoice.pdf"
}

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

Authorizations

Authorization

string

header

required

Enter your API key

Body

application/json

The body is of type Request Data · object.

Response

Successful Response

document_type

string

required

extraction_schema

ExtractionSchema · object

required

Show child attributes

confidence

number

required

Required range: 0 <= x <= 1

Check Extraction Status Generate Schema Asynchronously

Getting Started

Common Features

User Research

Image Extraction

Freshdesk Quality Assistant

Generate Extraction Schema

Features

Request Body

Authorizations

Body

Response

​Features

​Request Body

Authorizations

Body

Response

Features

Request Body