API Reference

The DocuProx Process API is the core document processing service that extracts structured data from images using predefined templates. It supports both reference-based and reference-free processing modes for various document types.

The /v1/process endpoint is the core synchronous service for document processing. It accepts images and returns extracted structured data based on your templates. Response format is determined by your template configuration.

{
  "actual_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "template_id": "123e4567-e89b-12d3-a456-426614174000",
  "static_values": "{ \"company_name\": \"Acme Corp\" }"
}

The /v1/process-job endpoint is an asynchronous document processing service. It immediately returns a job ID, allowing you to check the status and retrieve results later. Supports batch processing via ZIP files containing multiple documents.

{
  "actual_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "template_id": "123e4567-e89b-12d3-a456-426614174000",
  "static_values": "{ \"company_name\": \"Acme Corp\" }"
}

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "template_id": "154bb430-c9d9-4154-9377-a3b0466fd836",
  "static_values": { "company_name": "Acme Corp" }
}

curl --location 'https://api.docuprox.com/v1/process-job' \
  --header 'x-auth: YOUR_API_KEY' \
  --form 'actual_image=@"/path/to/document.jpg"' \
  --form 'template_id="154bb430-c9d9-4154-9377-a3b0466fd836"' \
  --form 'static_values="{ \"company_name\": \"Acme Corp\" }"'

curl --location --globoff --request PUT \
  'https://api.docuprox.com/v1/process?t_id=YOUR_TEMPLATE_ID' \
  --header 'x-auth: YOUR_API_KEY' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary '@/path/to/document.pdf'

The /v1/process-agent endpoint provides advanced document processing with custom prompts and instructions. It allows you to define extraction fields dynamically using a JSON payload.

{
  "document_type": "passport",
  "custom_instructions": "",
  "prompt_json": {
    "passport": "from given document extract the passport number"
  },
  "static_values": "{ \"company_name\": \"Acme Corp\" }"
}

{
  "actual_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "template_id": "123e4567-e89b-12d3-a456-426614174000",
  "payload": {
    "document_type": "passport",
    "custom_instructions": "",
    "prompt_json": {
      "passport": "from given document extract the passport number"
    },
    "static_values": "{ \"company_name\": \"Acme Corp\" }"
  }
}

curl --location 'https://api.docuprox.com/v1/process-agent' \
  --header 'x-auth: YOUR_API_KEY' \
  --form 'actual_image=@"/path/to/document.jpg"' \
  --form 'template_id="154bb430-c9d9-4154-9377-a3b0466fd836"' \
  --form 'payload="{
    \"document_type\": \"passport\",
    \"custom_instructions\": \"\",
    \"prompt_json\": {
      \"passport\": \"from given document extract the passport number\"
    },
    \"static_values\": \"{ \\\"company_name\\\": \\\"Acme Corp\\\" }\"
  }"'

The /v1/job-status endpoint allows you to check the processing status of an asynchronous job created via the Process Job API.

curl --location \
  'https://api.docuprox.com/v1/job-status?job_id=JOB_ID' \
  --header 'x-auth: YOUR_API_KEY'

The /v1/job-results endpoint retrieves the processed results for a completed job. Results can be returned in JSON or CSV format.

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "result_format": "json"
}

curl --location 'https://api.docuprox.com/v1/job-results' \
  --header 'x-auth: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "result_format": "json"
  }'

curl --location 'https://api.docuprox.com/v1/job-results' \
  --header 'x-auth: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "result_format": "csv"
  }'

Complete code examples for integrating the Process API in popular programming languages.

const response = await fetch('/v1/process', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-auth': 'dp-123-your-api-key'
  },
  body: JSON.stringify({
    actual_image: 'data:image/jpeg;base64,...',
    template_id: '123e4567-e89b-12d3',
    static_values: "{ \"company_name\": \"Acme Corp\" }"
  })
});
const result = await response.json();
// Process result

import requests
import base64
# Read and encode image
with open('document.jpg', 'rb') as f:
    image_data = base64.b64encode(f.read()).decode()
response = requests.post('/v1/process', 
  headers={
    'Content-Type': 'application/json',
    'x-auth': 'dp-123-your-api-key'
  },
  json={
    'actual_image': f'data:image/jpeg;base64,{image_data}',
    'template_id': '123e4567-e89b-12d3',
    'static_values': "{ \"company_name\": \"Acme Corp\" }"
  }
)
result = response.json()
print(result)

curl -X POST https://api.docuprox.com/v1/process \
  -H "Content-Type: application/json" \
  -H "x-auth: dp-123-your-api-key" \
  -d '{
    "actual_image": "data:image/jpeg;base64,/9j/4AAQ...",
    "template_id": "123e4567-e89b-12d3-a456-426614174000",
    "static_values": "{ \"company_name\": \"Acme Corp\" }"
  }'

curl -X POST https://api.docuprox.com/v1/process \
  -H "x-auth: dp-123-your-api-key" \
  -F "actual_image=@/path/to/document.jpg" \
  -F "template_id=123e4567-e89b-12d3-a456-426614174000" \
  -F "static_values={ \"company_name\": \"Acme Corp\" }"

curl --location --globoff --request PUT \
  'https://api.docuprox.com/v1/process?t_id=YOUR_TEMPLATE_ID' \
  --header 'x-auth: dp-123-your-api-key' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary '@/path/to/document.pdf'