Skip to main content

Welcome to Document Analysis API

Welcome to the comprehensive API documentation for Document Analysis, a powerful REST API that provides token-based authentication, a flexible credit system, and advanced document processing capabilities.

What is Document Analysis?​

Document Analysis is a modern API platform designed to:

  • Process Documents - Analyze PDFs, images, and spreadsheets with AI-powered insights
  • Track Usage - Monitor token consumption with detailed per-step tracking
  • Manage Credits - Use a flexible credit system for API consumption
  • Secure Access - Token-based authentication with multi-factor authentication support
  • Scale Operations - Handle multiple concurrent tasks with a robust task execution framework

Key Features​

Authentication & Security​

  • Token-based API authentication
  • Secure password reset with dual-code verification
  • Two-Factor Authentication (2FA) with TOTP support
  • Email alias prevention to protect account integrity
  • Admin panel for user management

Credit & Payment System​

  • Flexible credit-based usage model
  • Stripe payment integration for credit purchases
  • Configurable credit deduction per endpoint
  • Transparent billing with detailed history
  • Automatic onboarding credits for new users

Document Processing​

  • Support for multiple file formats: PDF, PNG, JPG, GIF, WebP, XLSX
  • AI-powered image extraction and relevance analysis
  • Automatic image compression to meet API limits
  • Vision-based document analysis
  • Modular step-based processing framework

Task Management​

  • Create reusable task definitions with custom prompts
  • Execute task runs with file uploads
  • Real-time status tracking
  • Detailed results and error handling
  • Automatic file retention policies

Usage Analytics​

  • Daily token usage tracking and aggregation
  • Per-task definition usage analytics
  • Historical data and trending
  • REST API and web UI access

Support​

For issues, feature requests, or questions:

  • Review the API Reference for detailed endpoint documentation
  • Check the Guides section for tutorials and best practices

Let's get started! Head over to the Getting Started Guide to begin integrating with the Document Analysis API.