Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trymaitai.com/llms.txt

Use this file to discover all available pages before exploring further.

The Maitai Developer API exposes the product resources most teams manage in the Portal: applications, intents, agents, workflows, datasets, test sets, test runs, sentinels, models, analytics, and quality workflows. The API is organized under: 
https://api.trymaitai.ai/api/v1

​
Covered resource groups

Use the API Reference sidebar for endpoint-level details. The public API currently includes:
  • Applications, intents, intent groups, sessions, requests, and evaluations
  • Agents, routing rules, and conversation trees
  • Workflows, workflow versions/releases, workflow artifacts, workflow runs, workflow test sets, and workflow test runs
  • Datasets, test sets, test runs, finetune runs, models, and model drift checks
  • Sentinels and evaluation criteria
  • Analytics, reports, tagging, continuous learning, and Compass searches
The CLI mirrors these top-level resources where a generic list/get/create/update/delete command is useful. For specialized actions, use maitai api with the endpoint path.

​
Response shapes

Most /api/v1 endpoints use the standard response envelope: 
{
  "data": {}
}
Some endpoints delegate to the same backend handlers used by the Portal for long-running or complex operations. These may return a Portal-shaped response rather than the standard envelope. The OpenAPI reference is the source of truth for each endpoint.

​
Not exposed

The Developer API intentionally does not expose internal account or operations controls, including:
  • Billing and account administration
  • API-key management
  • User permissions and company administration
  • Email/notification delivery controls
  • Infrastructure-admin and VAST instance controls
There are also a few Portal-only product helpers that are not yet part of /api/v1: application context file management, dataset review/public-review workflows, shared-resource sharing, sandbox conversations, and some import/search/validation helper endpoints.

​
Choosing an interface

  • Use the API Reference when integrating directly over HTTP.
  • Use the CLI Reference for terminal workflows and scripts.
  • Use the generated maitai api command for specialized endpoints that do not have a dedicated top-level CLI command.