Full API Documentation¶

For complete, interactive API documentation, use the auto-generated API docs provided by the SaaS API.

Interactive API Documentation¶

ReDoc (Recommended)¶

Beautiful, responsive API documentation with examples

Open ReDoc Documentation (Production)

Open ReDoc Documentation (Local)

ReDoc provides: - ✅ Clean, professional interface - ✅ Comprehensive endpoint documentation - ✅ Request/response schemas - ✅ Example payloads - ✅ Model definitions - ✅ Authentication details - ✅ Mobile-friendly

URL: http://localhost:8003/redoc

Swagger UI¶

Interactive API explorer with "Try it out" functionality

Open Swagger UI (Production)

Open Swagger UI (Local)

Swagger UI provides: - ✅ Try API calls directly in the browser - ✅ Interactive request builder - ✅ Real-time response preview - ✅ Schema validation - ✅ Authentication testing - ✅ Download OpenAPI spec

URL: http://localhost:8003/docs

What's Available¶

Both interfaces provide complete documentation for:

Organizations API¶

• Create, read, update, delete organizations
• List organization teams
• Get organization usage statistics

Teams API¶

• Create, read, update, delete teams
• Manage model access groups
• Suspend/resume teams
• View team credits

Model Access Groups API¶

• Create and manage access groups
• Assign model aliases
• Control team access

Model Aliases API¶

• Create model aliases
• Configure pricing (input/output tokens)
• Provider configuration

Jobs API¶

• Create jobs
• Single-call job endpoints (streaming and non-streaming)
• POST /api/jobs/create-and-call - Non-streaming single-call
• POST /api/jobs/create-and-call-stream - Streaming single-call (SSE)
• Make LLM calls within jobs
• Complete jobs
• Get job details and costs

Credits API¶

• Check credit balance
• Add credits
• View credit transactions
• Credit availability check

Health & Status¶

• Health check endpoint
• System status

Quick Access¶

Using the Interactive Docs¶

ReDoc Interface¶

1. Browse endpoints - Navigate through the API structure
2. View schemas - See request/response models
3. Copy examples - Use example code in your app
4. Search - Find specific endpoints quickly

Swagger UI Interface¶

1. Select an endpoint - Click on any API endpoint
2. Click "Try it out" - Enable interactive mode
3. Fill parameters - Add your virtual key and request data
4. Execute - Send the request and see live results

OpenAPI Specification¶

Download the OpenAPI 3.0 specification to: - Generate client libraries - Import into API testing tools (Postman, Insomnia) - Build custom tooling - Integrate with CI/CD

# Download OpenAPI spec
curl http://localhost:8003/openapi.json > saas-api-spec.json

Production URLs¶

When deploying to production, the API documentation will be available at:

Additional API Resources¶

Beyond the interactive documentation, explore these resources:

Detailed Guides¶

• API Overview - Introduction to the API structure
• Jobs API - Job management endpoints
• LLM Calls API - Making LLM calls
• Teams API - Team management
• Organizations API - Organization management

Integration Guides¶

• Integration Overview - How to integrate
• Authentication - Virtual key auth
• Job Workflow - Job-based pattern
• Streaming - SSE streaming guide

Examples¶

• Basic Usage - Simple examples
• Streaming Examples - Real-time streaming
• Full Chain - Complete workflow

Getting Help¶

If you have questions about the API:

1. Check the interactive docs - Most questions are answered there
2. Review the integration guides - Detailed explanations and examples
3. Try the examples - Working code you can run locally

Screenshots¶

ReDoc Interface¶

Clean, professional API documentation with ReDoc

Swagger UI Interface¶

Interactive API testing with Swagger UI