OpenAPI Specifications

Complete OpenAPI 3.0 specifications for all OctoLLM services.

Available Specifications

Core Services

Orchestrator API - Central coordination service
Reflex Layer API - Preprocessing and caching

Arm Services

Planner Arm API - Task decomposition
Tool Executor API - Command execution
Retriever Arm API - Knowledge base search
Coder Arm API - Code generation/debugging
Judge Arm API - Output validation
Safety Guardian API - PII detection/filtering

Interactive Documentation

When running services locally, interactive API documentation is available:

Orchestrator:

Swagger UI: http://localhost:8000/docs
ReDoc: http://localhost:8000/redoc

Reflex Layer:

Swagger UI: http://localhost:8001/docs
ReDoc: http://localhost:8001/redoc

YAML Specifications

Raw OpenAPI YAML files are available in the repository:

docs/api/openapi/
├── orchestrator.yaml
├── reflex-layer.yaml
├── planner.yaml
├── executor.yaml
├── retriever.yaml
├── coder.yaml
├── judge.yaml
└── safety-guardian.yaml

Generating Client SDKs

Use OpenAPI Generator to create client SDKs:

# Python SDK
openapi-generator-cli generate \
  -i docs/api/openapi/orchestrator.yaml \
  -g python \
  -o clients/python

# TypeScript SDK
openapi-generator-cli generate \
  -i docs/api/openapi/orchestrator.yaml \
  -g typescript-axios \
  -o clients/typescript

OctoLLM Documentation