Skip to main content
Interactive API Reference: Explore all endpoints with the interactive API playground in the navigation. This page covers API-wide conventions and standards.

Base URL

https://api-vision.fintelite.ai
All API requests should be made to this base URL. For authentication details, see Authentication.

Error Codes

Common Codes:
  • FILE_TOO_LARGE: File exceeds 20MB limit
  • BAD_REQUEST: Invalid request parameters
  • INVALID_REQUEST: Request format or content is invalid
  • INVALID_SCHEMA: JSON schema is malformed
  • INVALID_FILE_FORMAT: Unsupported file format
  • INVALID_DOCUMENT_TYPE: Document type not supported
  • INVALID_JOB_STATE: Job not in valid state for operation
  • MISSING_REQUIRED_FIELD: Required field is missing
  • MAX_RETRIES_EXCEEDED: Job retry limit reached
Example:
{
  "error": {
    "code": "FILE_TOO_LARGE",
    "message": "File exceeds 20MB limit"
  }
}
Common Codes:
  • INVALID_API_KEY: API key is invalid or inactive
  • MISSING_API_KEY: No API key provided
Example:
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Authentication failed"
  }
}
Common Codes:
  • NOT_FOUND: Resource not found
  • FILE_NOT_FOUND: File ID does not exist
  • JOB_NOT_FOUND: Job ID does not exist
  • TEMPLATE_NOT_FOUND: Template ID does not exist
Example:
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}
Common Codes:
  • QUOTA_EXCEEDED: Plan limits reached (monthly/daily quota)
  • RATE_LIMITED: Too many requests per minute
  • RATE_LIMIT_EXCEEDED: Rate limit threshold exceeded
Example:
{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Plan limits reached"
  }
}
Common Codes:
  • PROCESSING_FAILED: Document processing error
  • JOB_PROCESSING_FAILED: Job execution failed
  • TEMPLATE_OPERATION_FAILED: Template operation error
  • INTERNAL_ERROR: Unexpected server error
  • SERVICE_UNAVAILABLE: Service temporarily unavailable
Example:
{
  "error": {
    "code": "PROCESSING_FAILED",
    "message": "Document processing error"
  }
}

Pagination

List endpoints support pagination with these parameters:
  • page: Page number (starts at 1)
  • limit: Items per page (max 20, default 10)
Example:
GET /jobs?page=2&limit=10
Response:
{
  "jobs": [...],
  "pagination": {
    "page": 2,
    "limit": 10,
    "total": 156,
    "total_pages": 16
  }
}

Webhooks

For async operations, configure webhooks to receive notifications:
{
  "webhook": {
    "url": "https://your-app.com/webhook",
    "metadata": {
      "custom_field": "value"
    }
  }
}
Your endpoint will receive POST requests with job results.

Best Practices

Use File IDs

Upload once, reference by ID for multiple operations

Implement Retry Logic

Handle transient errors with exponential backoff

Monitor Rate Limits

Check rate limit headers and adjust request rate

Use Async for Large Files

Use async endpoints for documents over 5 pages

SDK and Libraries

Official SDKs are coming soon. For now, use standard HTTP clients in your preferred language.

Support