API
ConceptsThe API (Application Programming Interface) is the DocLD REST API that provides programmatic access to all core capabilities: document upload and parsing, extraction, RAG chat, knowledge base management, and workflow automation. Integrate DocLD into your applications using standard HTTP requests with JSON payloads.
API Overview
The DocLD API is versioned at v1. Base URL: https://docld.com/api/v1. Endpoints are organized by capability:
| Area | Endpoints | Description |
|---|---|---|
| Documents | POST/GET/DELETE /v1/documents, GET /v1/documents/:id/content | Upload, list, manage, get content |
| Collections | POST/GET /v1/collections, POST /v1/collections/:id/documents | Create and configure collections (knowledge bases) |
| Schemas | POST/GET /v1/schemas, GET/POST/DELETE /v1/schemas/:id | Manage extraction schemas |
| Extractions | POST /v1/extractions, GET /v1/extractions/:id | Run extraction, get result |
| Chat | POST /v1/chat/completions | RAG chat over a collection |
| Search | POST /v1/search | Semantic search |
| Jobs | GET /v1/jobs/:id | Check processing status |
Authentication uses API keys in the Authorization: Bearer docld_... header. Rate limits and quotas apply per plan. Full reference: API Reference.
How to Use the API
- Obtain an API key — Generate keys from the DocLD dashboard under Settings
- Base URL —
https://docld.com/api/v1 - Send requests — Use
POST,GET, orDELETEwith JSON or multipart bodies as documented - Handle responses — JSON with status codes, pagination where relevant, and error details
Example: Upload a document (parsing starts automatically):
curl -X POST "https://docld.com/api/v1/documents" \ -H "Authorization: Bearer docld_..." \ -F "file=@invoice.pdf"
Async Operations
Many operations are asynchronous. Extraction and parsing return a job ID. Poll the job endpoint or use webhooks to be notified when processing completes.
Related Concepts
The API powers extraction, parsing, and workflow automation. Use webhooks for event-driven integrations.