Skip to main content

​
Base URL

https://api.documind.cloud/api/v1

​
Authentication

All API requests must include your API key in the X-API-Key header: 
X-API-Key: YOUR_API_KEY

​
Creating API Keys

Create API keys in the Documind Dashboard.
Never share your API keys or commit them to version control. Use environment variables to store them securely.

​
Request Format

All API requests use JSON format: 
curl https://api.documind.cloud/api/v1/extract/{document_id} \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"schema": {...}, "model": "google-gemini-2.0-flash"}'

​
Response Format

All successful responses return JSON with a 200 status code: 
{
  "document_id": "123e4567-e89b-12d3-a456-426614174000",
  "results": {...},
  "needs_review": false
}

​
Error Responses

Errors return appropriate HTTP status codes with details: 
{
  "detail": "Error message describing what went wrong"
}

​
Common Status Codes

CodeStatusMeaning
200OKRequest succeeded
400Bad RequestInvalid parameters
401UnauthorizedInvalid/missing API key
402Payment RequiredInsufficient credits
403ForbiddenInsufficient permissions
404Not FoundResource not found
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error

​
Rate Limits

Rate limits vary by subscription tier. Monitor your usage via the /usage/current endpoint.

​
Pagination

List endpoints support pagination: 
GET /api/v1/data/extractions?skip=0&limit=100
Parameters:
  • skip: Number of items to skip (default: 0)
  • limit: Maximum items to return (default: 100, max: 1000)
Response includes pagination metadata: 
{
  "items": [...],
  "total": 500,
  "skip": 0,
  "limit": 100
}

​
Filtering

Many endpoints support filtering by query parameters: 
GET /api/v1/data/extractions?needs_review=true&created_after=2024-01-01

​
Sorting

List endpoints support sorting: 
GET /api/v1/data/extractions?sort_by=created_at&sort_order=desc

​
Idempotency

Upload operations are idempotent within a short time window. If you upload the same file multiple times within 5 minutes, you’ll receive the same document ID.

​
Webhooks

Webhook support is coming soon. For now, use polling to check extraction status.

​
API Versioning

The API is versioned via the URL (/api/v1/). Breaking changes will be introduced in new versions (/api/v2/), while the current version will remain supported.

​
SDKs and Client Libraries

Official SDKs:
  • Python SDK (coming soon)
  • Node.js SDK (coming soon)
  • REST API (available now)

​
Endpoint Categories

Core Endpoints

Upload, extract, and generate schemas

Data & Querying

Query and filter extractions

Documents

Manage uploaded documents

API Keys

Create and manage API keys

User Settings

Manage user preferences and schemas

Usage & Credits

Monitor usage and credits

​
Getting Help

Upload Documents

POST /upload

Extract Data

POST /extract/

List Extractions

GET /data/extractions

Get Credits

GET /usage/credits