API Overview

PreviousNext

Introduction to the 1Flow API

Authentication

All API requests require authentication using API keys:

curl -X POST https://api.1flow.io/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Document"}'

Base URL

All API requests should be made to:

https://api.1flow.io/v1

Rate Limits

API requests are rate-limited:

  • Free tier: 100 requests per hour
  • Pro tier: 10,000 requests per hour
  • Enterprise: Custom limits

Response Format

All API responses are in JSON format:

{
  "success": true,
  "data": {
    "id": "doc_123",
    "name": "Invoice.pdf"
  }
}

Error Handling

Errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The provided document type is invalid"
  }
}

Endpoints

Documents

  • POST /documents - Create a document
  • GET /documents/:id - Get document details
  • PUT /documents/:id - Update a document
  • DELETE /documents/:id - Delete a document

Search

  • POST /search - Search across documents
  • GET /search/entities - Get searchable entities

Extraction

  • POST /extract - Extract data from a document
  • GET /extract/status/:id - Get extraction status

SDKs

Official SDKs are available for:

  • JavaScript/TypeScript
  • Python
  • Ruby