Skip to main content

OpenAPI Specifications

The naturali.ai API is fully documented using OpenAPI 3.0.3 specifications, one hand-authored 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
Actors/openapi/actors.yaml
Addresses/openapi/addresses.yaml
Agents/openapi/agents.yaml
Api Keys/openapi/api-keys.yaml
Assistant/openapi/assistant.yaml
Auth/openapi/auth.yaml
Boards/openapi/boards.yaml
Channel Kinds/openapi/channel-kinds.yaml
Channel Routes/openapi/channel-routes.yaml
Channels/openapi/channels.yaml
Generations/openapi/generations.yaml
Knowledge/openapi/knowledge.yaml
Models/openapi/models.yaml
Orchestrations/openapi/orchestrations.yaml
Projects/openapi/projects.yaml
Providers/openapi/providers.yaml
Sessions/openapi/sessions.yaml
Tasks/openapi/tasks.yaml
Tools/openapi/tools.yaml
Traces/openapi/traces.yaml
Triggers/openapi/triggers.yaml
Webhooks/openapi/webhooks.yaml