docs / api-reference

Build with Azure.

OpenAI- and Anthropic-compatible endpoints, Responses API support, usage estimates, streaming, tools, and project APIs.

API access requires an active Pro plan. Keep credentials server-side.

post/v1/chat/completions

Create an OpenAI-compatible chat completion

post/v1/responses

Create an OpenAI Responses-compatible response

post/v1/messages

Create an Anthropic-compatible message

post/v1/messages/count_tokens

Estimate Anthropic request input tokens

post/v1/images/generations

Generate images

get/api/account/usage

Read authenticated usage analytics

Returns bounded usage totals grouped by model, API-key label, endpoint, and UTC day. Cost values are estimates.

post/api/account/estimate

Estimate request tokens and cost

Estimates raw tokens, weighted allowance tokens, and model cost without sending a model request.

get/api/account/notifications

List account notifications

Returns in-app plan-expiry and service notifications for the signed-in account.

post/api/account/notifications/{id}/read

Mark a notification as read

get/api/integrations

List integrations

Lists configured Slack, Discord, GitLab, and Bitbucket integrations without returning endpoint credentials.

post/api/integrations

Create an integration

Creates an encrypted, host-validated integration endpoint. Secrets are hashed and never returned.

delete/api/integrations/{id}

Delete an integration

post/api/integrations/{id}/test

Send an integration test event

post/api/integrations/hooks/{id}

Receive a signed integration hook

get/api/admin/analytics

Read protected admin analytics

Returns aggregate usage, latency percentiles, model/provider health, plan, and project metrics. Prompt contents and credentials are excluded.

get/api/status

Read public model health

Returns privacy-preserving rolling status and latency telemetry for public models.

get/api/projects/{projectId}/snapshots

List Canvas snapshots

post/api/projects/{projectId}/snapshots

Create a Canvas snapshot

get/api/projects/{projectId}/snapshots/{snapshotId}

Read a Canvas snapshot

post/api/projects/{projectId}/snapshots/{snapshotId}/restore

Restore a Canvas snapshot

get/api/projects/{projectId}/jobs

List resumable project jobs

post/api/projects/{projectId}/jobs

Queue a resumable project job

get/api/projects/{projectId}/jobs/{jobId}

Read resumable project job status

delete/api/projects/{projectId}/jobs/{jobId}

Cancel a resumable project job

Generated from the OpenAPI source in `docs/openapi.json`.