Skip to main content

OpenAPI Specifications

The naturali.ai API is fully documented using OpenAPI 3.0.3 specifications, one YAML file per resource (see api/openapi/README.md). Each resource is served at /openapi/<resource>.yaml.

These specs can be used directly with any OpenAPI-compatible tool (Postman, code generators, AI agents, etc.), and are merged at build time into the single document served by the API at GET /v1/openapi.json.

ResourceURL
Activity/openapi/activity.yaml
Actors/openapi/actors.yaml
Addresses/openapi/addresses.yaml
Agents/openapi/agents.yaml
Ai Providers/openapi/ai-providers.yaml
Api Keys/openapi/api-keys.yaml
Approvals/openapi/approvals.yaml
Assistant/openapi/assistant.yaml
Audit Log/openapi/audit-log.yaml
Auth/openapi/auth.yaml
Chains/openapi/chains.yaml
Channel Kinds/openapi/channel-kinds.yaml
Channel Routes/openapi/channel-routes.yaml
Channels/openapi/channels.yaml
Conversations/openapi/conversations.yaml
Deciders/openapi/deciders.yaml
Documents/openapi/documents.yaml
Embeddings/openapi/embeddings.yaml
Evaluations/openapi/evaluations.yaml
Exceptions/openapi/exceptions.yaml
Files/openapi/files.yaml
Formations/openapi/formations.yaml
Generations/openapi/generations.yaml
Guardrails/openapi/guardrails.yaml
Ingestion Rules/openapi/ingestion-rules.yaml
Installs/openapi/installs.yaml
Knowledge/openapi/knowledge.yaml
Listings/openapi/listings.yaml
Memories/openapi/memories.yaml
Memory Rules/openapi/memory-rules.yaml
Memory Stores/openapi/memory-stores.yaml
Metadata Schemas/openapi/metadata-schemas.yaml
Model Routes/openapi/model-routes.yaml
Models/openapi/models.yaml
Orchestrations/openapi/orchestrations.yaml
Projects/openapi/projects.yaml
Quotas/openapi/quotas.yaml
Secrets/openapi/secrets.yaml
Sessions/openapi/sessions.yaml
Tasks/openapi/tasks.yaml
Tools/openapi/tools.yaml
Traces/openapi/traces.yaml
Triggers/openapi/triggers.yaml
Users/openapi/users.yaml
Webhooks/openapi/webhooks.yaml
Workflows/openapi/workflows.yaml