Skip to main content

​
Welcome to the doXmind API

The doXmind API is a powerful RESTful interface that allows you to integrate intelligent document processing capabilities into your applications. With our API, you can create, analyze, enhance, and manage documents programmatically.

​
Base URL

All API requests should be made to: 
https://api.doxmind.com/v1

​
Authentication

The doXmind API uses API keys for authentication. Include your API key in the request header: 
Authorization: Bearer YOUR_API_KEY
Get your API key from the Dashboard

​
Example Request

curl https://api.doxmind.com/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Response Format

All API responses return JSON with the following structure:

​
Success Response

{
  "success": true,
  "data": {
    // Response data
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is invalid",
    "details": {
      "field": "title",
      "issue": "Required field missing"
    }
  },
  "meta": {
    "requestId": "req_xyz789",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

​
Rate Limits

API rate limits vary by plan:
PlanRequests/MinuteRequests/HourRequests/Day
Free101001,000
Plus601,00010,000
Pro3005,00050,000
EnterpriseCustomCustomCustom
Rate limit information is included in response headers: 
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1673784000

​
Error Codes

Common error codes you might encounter:
CodeDescription
INVALID_REQUESTThe request is malformed or missing required parameters
UNAUTHORIZEDInvalid or missing API key
FORBIDDENValid API key but insufficient permissions
NOT_FOUNDRequested resource doesn’t exist
RATE_LIMIT_EXCEEDEDToo many requests
INTERNAL_ERRORServer error - our team is notified automatically

​
Pagination

List endpoints support pagination with the following parameters:
ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger20Items per page (max: 100)
sortstringcreated_atSort field
orderstringdescSort order (asc or desc)
Example: 
GET /v1/documents?page=2&limit=50&sort=updated_at&order=desc
Paginated responses include metadata: 
{
  "data": [...],
  "meta": {
    "pagination": {
      "page": 2,
      "limit": 50,
      "total": 245,
      "pages": 5,
      "hasMore": true
    }
  }
}

​
Webhooks

Configure webhooks to receive real-time updates: 
POST /v1/webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["document.created", "document.updated"],
  "secret": "your_webhook_secret"
}

​
SDK Support

Official SDKs are available for:

JavaScript/TypeScript

npm install @doxmind/sdk

Python

pip install doxmind

Go

go get github.com/doxmind/doxmind-go

Ruby

gem install doxmind

​
Quick Start

Here’s a simple example to get you started: 
curl -X POST https://api.doxmind.com/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First Document",
    "type": "report",
    "content": "This is the beginning of something great."
  }'

​
Next Steps

Documents API

Create and manage documents

AI Operations

Enhance documents with AI

Templates

Work with document templates

Webhooks

Set up real-time notifications