Skip to main content
POST
/
api
/
v1
/
extract
/
batch
Batch Extraction
curl --request POST \
  --url https://extraction-api.nanonets.com/api/v1/extract/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form output_format=markdown \
  --form files.items='@example-file'
{
  "success": true,
  "message": "<string>",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_files": 123,
  "accepted_files": 123,
  "rejected_files": 123,
  "records": [
    {
      "success": true,
      "message": "<string>",
      "record_id": "<string>",
      "status": "completed",
      "result": {
        "markdown": {
          "content": "<string>",
          "metadata": {
            "bounding_boxes": {},
            "confidence_score": {}
          }
        },
        "html": {
          "content": "<string>",
          "metadata": {
            "bounding_boxes": {},
            "confidence_score": {}
          }
        },
        "json": {
          "content": "<string>",
          "metadata": {
            "bounding_boxes": {},
            "confidence_score": {}
          }
        },
        "csv": {
          "content": "<string>",
          "metadata": {
            "bounding_boxes": {},
            "confidence_score": {}
          }
        }
      },
      "processing_time": 123,
      "filename": "<string>",
      "output_format": "<string>",
      "file_size": 123,
      "pages_processed": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer YOUR_API_KEY

Body

multipart/form-data
files
file[]
required

Files to process (max 50)

Maximum array length: 50
output_format
string
required

Output format(s) for all files

Example:

"markdown"

custom_instructions
string
Maximum string length: 8000
prompt_mode
enum<string>
default:append
Available options:
append,
replace
json_options
string
csv_options
string
include_metadata
string

Response

Batch queued

success
boolean
required
message
string
required
batch_id
string<uuid>
required
total_files
integer
required
accepted_files
integer
required
rejected_files
integer
required
records
object[]
required