API

API Technical Documentation

Integration architecture overview for technical specialists. Asynchronous interaction protocol, data format specifications, and reliability mechanisms.

Architectural Principles

  • Asynchronous Processing: using Polling pattern (202 Accepted) for high-load scenarios.
  • Idempotency: support for Idempotency-Key header to guarantee correct processing of retries.
  • Strict Typing: input data validation (JSON Schema) at API Gateway level. Main payload format: { "text": "..." }.
  • Rate Limiting: request quotas at organization level (RPS/RPM) for infrastructure protection.
  • Zero-Log Policy: optional mode without persistent data storage (in-memory processing + TTL).

Note: API is optimized for text data processing. Processing binary files (PDF, images) requires preliminary OCR on the client side or use of a specialized endpoint (available in extended version).

Specification and Access

Full technical documentation, including endpoint descriptions, data models, and error codes, is provided to partners after signing the agreement.

  • Authentication: API Key / Bearer Token authentication.
  • Versioning: API versioning support to ensure backward compatibility.
  • Error Handling: standardized error codes and detailed messages for debugging.
  • SDK & Examples: integration examples for popular programming languages (Python, JavaScript/TypeScript, Go).

To get access to the API and full documentation, please submit an application.

Workflow

  1. Initiate Processing: Sending a POST request with payload and Idempotency-Key header.
  2. Acknowledgement: Receiving 202 Accepted response with task_id.
  3. Polling: Periodic task status polling by task_id (recommended interval and backoff strategy are specified in documentation).
  4. Retrieve Result: Receiving processing result when status is COMPLETED.

As part of the pilot project, prompts and generation templates are configured for your specific business processes.

Discuss Integration