Skip to main content

Prerequisites

  • AIDA must be enabled on your tenant by AODocs support
  • AIDA must be enabled on each library you want to use it with (PUT /assistant/api/v1/tenants/{tenant}/libraries/{library_id})
  • Authentication uses the same OAuth2 Bearer token as the AODocs core API — your client ID must be whitelisted in AODocs

Document Assistant API 1.1.0

Base URL
Choose your region. AIDA is hosted in two production regions. Use the base URL that matches where your tenant is provisioned, and select the matching server in the API playground’s base URL selector when trying requests.

Chat v2

Semantic question answering over your documents. Structured response by paragraph with source references. Recommended for all new integrations.

Chat v1

Legacy chat endpoint. Returns a single text block. Fields library_id and document_id are deprecated — use library_ids / document_ids.

Metadata Extraction

Extract structured fields from documents using predefined or custom schemas. Supports confidence scoring and evaluation workflows.

Document Validation

Validate documents against rules (regex, blacklist, LLM-based). Returns violations with severity and whitelist support.

Translation

Translate document content. Operates on AODocs document identifiers.

Document Split

Split a document into logical sections based on content analysis.

Document Similarity

Compute similarity scores between documents within a library.

Document Conflict

Detect conflicts between a source document and a class of target documents. Asynchronous — results delivered via Pub/Sub.

Tenant & Library

Activate and configure AIDA on a tenant or library. Monitor indexation status.

A2A

Agent-to-agent protocol. Exposes AIDA as an agent card for integration with external AI orchestration systems.

Relation to the AODocs core API

AIDA uses the same identifiers as the AODocs core API — tenant IDs, library IDs, and document IDs are interchangeable between the two APIs. Authentication is shared. See the Authentication section for details.