2 min read

API Reference

Complete reference documentation for the DocuRift API

Welcome to the DocuRift API reference. This documentation covers all available endpoints, request/response formats, and authentication methods. Whether you're building a simple integration or a complex document processing pipeline, this reference provides everything you need to work with the DocuRift API effectively.

The DocuRift API is a RESTful service that accepts JSON requests and returns JSON responses. All API endpoints use HTTPS to ensure secure data transmission. The API is designed to be intuitive and follows standard REST conventions, making it easy to integrate with any programming language or platform.

Base URL

All API requests should be made to:

https://api.docurift.com/v1

Available Endpoints

Authentication

Authentication

Learn how to authenticate your API requests

Documents

Documents API

Process, retrieve, and manage documents

Jobs

Jobs API

Monitor and manage processing jobs

Credits

Credits API

Manage your API credits and usage

API Keys

API Keys

Create and manage API keys

Response Format

All API responses are returned in JSON format with the following structure:

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

Error Handling

When an error occurs, the API returns an error response:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is invalid",
    "details": { ... }
  },
  "meta": {
    "requestId": "req_abc123"
  }
}

See Error Codes for a complete list of error codes.

Rate Limits

API requests are rate limited based on your subscription plan:

| Plan | Requests/minute | Concurrent requests | |------|-----------------|---------------------| | Free | 60 | 5 | | Pro | 300 | 20 | | Enterprise | Unlimited | Unlimited |

Next Steps