Platform endpoints
/v1/*Health, allowance, usage logs, request polling, webhook management, and API key management.
What this section covers
Endpoint-level reference for the current /v1/* surface.
Platform endpoints are the connective tissue around the generation APIs. They let you inspect allowance, read recent usage, poll async requests, manage webhooks, and provision keys.
These routes are where most integrations handle state, observability, and operational workflows after the first successful generation call.
Start here
Use GET/v1/health for connectivity checks and GET/v1/credits for allowance checks.
Use GET/v1/requests/:requestId or webhooks to complete async flows cleanly.
Use POST/v1/apikeys only from a dashboard session, not from an API key.
Status and allowance
Public readiness checks and remaining API call allowance.
Usage and request status
Read logs and poll long-running requests.
List public API usage logs
/v1/usageList request logs for the authenticated workspace with optional filtering.
Read request status
/v1/requests/:requestIdRead the latest state for a previously created async request.
Webhook management
Register, inspect, and disable webhook receivers.
Create a webhook destination
/v1/webhooksRegister an HTTPS endpoint for async completion events.
List webhook destinations
/v1/webhooksList webhook destinations for the authenticated workspace.
Disable a webhook destination
/v1/webhooks/:webhookIdDisable a webhook destination without removing its historical deliveries.
API key management
Create, list, and revoke keys for a workspace.
Create an API key
/v1/apikeysCreate an API key from a signed-in dashboard session.
List API keys
/v1/apikeysList API keys for the authenticated workspace.
Revoke an API key
/v1/apikeys/:keyIdRevoke an API key for the authenticated workspace.