API Reference
The C_AI Platform provides a RESTful API for programmatic access to all platform features.
OpenAPI specification
The API is documented using OpenAPI 3.x specification; coverage expands as endpoints are added. The generated interactive documentation is available in the Platform API section.
Accessing the API docs
Navigate to API Reference → Platform API in the sidebar to explore:
- All available endpoints
- Request and response schemas
- Interactive "Try it out" functionality
- Authentication requirements
Regenerating API documentation
The API documentation is auto-generated from the OpenAPI specification file. To regenerate after specification changes:
cd docs-site
yarn gen:api
This command:
- Reads
openapi/platform.yaml - Generates MDX files in
docs/api/platform/ - Updates the sidebar configuration
OpenAPI specification location
| File | Purpose |
|---|---|
docs-site/openapi/platform.yaml | Source OpenAPI 3.x specification |
docs-site/docs/api/platform/ | Generated MDX documentation |
docs-site/docs/api/platform/sidebar.ts | Generated sidebar configuration |
API versioning
The API uses URL-based versioning. The current version is v1.
https://api.c-ai.example.com/v1/health
Authentication
API authentication details will be documented as endpoints are added to the specification.
Rate limiting
Rate limiting policies will be documented as they are implemented.