Stable v1.0Last updated recently

API Reference

Complete documentation of all DocScanner API endpoints and methods.

Base URL

text

/api/v1

Authentication

All requests must include your API key in the header:x-api-key

Core Endpoints

POST/documents/upload_files

Upload one or multiple documents securely for processing.

Request Parameters

Name	Type	Description
`files[]`Required	`Array<File>`	Array of documents to upload

cURL Example

curl -X POST "/api/v1/documents/upload_files" \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -F "files[]=@/path/to/file1.pdf" \
  -F "files[]=@/path/to/file2.jpg" \
  -F "files[]=@/path/to/file3.png"

GET/documents/get_documents

Retrieve a paginated list of all uploaded documents.

Query Parameters

Name	Type	Description
`page`	`Integer`	Page number (default: 1)
`limit`	`Integer`	Number of documents per page
`status_filter`	`String`	Filter by status (processing, completed, failed)
`search`	`String`	Search by filename or content

cURL Example

curl -X GET "/api/v1/documents/get_documents?page=1&limit=10&status_filter=completed&search=frontend" \
  -H "x-api-key: YOUR_API_KEY_HERE"

GET/documents/get_document/{document_id}

Retrieve detailed information about a single document by ID.

Path Parameters

Name	Type	Description
`document_id`Required	`Integer`	ID of the document to retrieve

cURL Example

curl -X GET "/api/v1/documents/get_document/101" \
  -H "x-api-key: YOUR_API_KEY_HERE"

POST/documents/retry_documents/{document_id}

Retry processing a document that failed or needs reprocessing.

Path Parameters

Name	Type	Description
`document_id`Required	`Integer`	ID of the document to retry processing

cURL Example

curl -X POST "/api/v1/documents/retry_documents/95" \
  -H "x-api-key: YOUR_API_KEY_HERE"