Skip to main content

API Overview

This guide provides a high-level overview of all Nanonets APIs, organized by functionality. Each section includes a brief description and links to the detailed API documentation.

Workflow Management APIs​

These APIs allow you to create, configure, and manage document processing workflows.

Core Workflow Operations​

Field and Table Management​

Workflow Configuration​

Document Processing APIs​

These APIs handle document upload, processing, and result retrieval.

Document Operations​

Common Use Cases​

Creating and Configuring a Workflow​

  1. Get available workflow types
  2. Create a new workflow
  3. Configure fields and tables
  4. Update workflow settings

Processing Documents​

  1. Upload documents for processing
  2. Monitor processing status
  3. Retrieve processing results
  4. Access page-level data

Best Practices​

Workflow Management​

  • Choose the appropriate workflow type for your use case
  • Configure fields and tables carefully
  • Use descriptive names and metadata
  • Monitor workflow performance

Document Processing​

  • Use async processing for large documents
  • Include relevant metadata
  • Implement proper error handling
  • Clean up processed documents

For detailed best practices, see the Best Practices Guide.

Error Handling​

All APIs return standard HTTP status codes and detailed error messages. Common scenarios include:

  • Authentication errors
  • Invalid requests
  • Resource not found
  • Processing failures

For detailed error handling, see the Error Handling Guide.

Rate Limits and Quotas​

  • API requests are subject to rate limits
  • Document processing has concurrent limits
  • Storage has usage quotas
  • Monitor your usage to avoid limits

For information about rate limits, see Rate Limits.