Skip to main content

OpenAPI Specifications

The SOAT REST API is fully documented using OpenAPI 3.x specifications. Each module has its own YAML file served at /openapi/<module>.yaml.

These specs can be used directly with any OpenAPI-compatible tool (Postman, Swagger UI, code generators, AI agents, etc.).

ModuleURL
Actors/openapi/actors.yaml
Agents/openapi/agents.yaml
Ai Providers/openapi/ai-providers.yaml
Api Keys/openapi/api-keys.yaml
Chats/openapi/chats.yaml
Conversations/openapi/conversations.yaml
Discussions/openapi/discussions.yaml
Documents/openapi/documents.yaml
Embeddings/openapi/embeddings.yaml
Files/openapi/files.yaml
Formations/openapi/formations.yaml
Generations/openapi/generations.yaml
Ingestion Rules/openapi/ingestion-rules.yaml
Knowledge/openapi/knowledge.yaml
Memories/openapi/memories.yaml
MemoryEntries/openapi/memoryEntries.yaml
Orchestrations/openapi/orchestrations.yaml
Policies/openapi/policies.yaml
Projects/openapi/projects.yaml
Secrets/openapi/secrets.yaml
Sessions/openapi/sessions.yaml
Tools/openapi/tools.yaml
Traces/openapi/traces.yaml
Triggers/openapi/triggers.yaml
Usage/openapi/usage.yaml
Users/openapi/users.yaml
Webhooks/openapi/webhooks.yaml