Skip to main content
POST
/
api
/
v1
/
classify
/
sync
Synchronous Classification
curl --request POST \
  --url https://extraction-api.nanonets.com/api/v1/classify/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'categories=[{"name": "Invoice", "description": "Bills and invoices"}, {"name": "Contract", "description": "Legal agreements"}]'
{
  "success": true,
  "message": "<string>",
  "result": {
    "filename": "<string>",
    "total_pages": 123,
    "pages": [
      {
        "page_number": 2,
        "category": "<string>",
        "confidence": 50,
        "reasoning": "<string>",
        "identified_category": "<string>"
      }
    ],
    "file_id": "<string>",
    "processing_time": 123,
    "error": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer YOUR_API_KEY

Body

multipart/form-data
file
file
required

File to classify (PDF, PNG, JPG, JPEG, TIFF, BMP, WebP)

categories
string
required

JSON array of category objects: [{"name": "Category Name", "description": "Optional description"}]

Example:

"[{\"name\": \"Invoice\", \"description\": \"Bills and invoices\"}, {\"name\": \"Contract\", \"description\": \"Legal agreements\"}]"

Response

Classification completed

success
boolean
required
message
string
required
result
object