API

OpenAI-compatible API, dashboard REST API, app-user provisioning, usage, and quota endpoints.

FastClaw exposes both product-facing REST APIs and an OpenAI-compatible API.

OpenAI-Compatible

POST /v1/chat/completions
GET  /v1/agents
POST /v1/users
GET  /v1/usage
PUT  /v1/quota
GET  /v1/quota
DELETE /v1/quota

Chat completions accepts standard bearer API keys:

curl http://localhost:18953/v1/chat/completions \
  -H "Authorization: Bearer $FASTCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "agt_xxx",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'

App User Provisioning

POST /v1/users

Use this when a SaaS product wants to map its own user IDs to FastClaw users. A type=user API key can also lazily create app users by sending:

X-Fastclaw-End-User: <your-app-user-id>

or by passing user in /v1/chat/completions.

Dashboard APIs

Key dashboard endpoints include:

POST /api/login
POST /api/logout
GET  /api/me
PUT  /api/me

GET  /api/agents
POST /api/agents
GET  /api/agents/{id}
PUT  /api/agents/{id}
DELETE /api/agents/{id}

GET  /api/agents/{id}/files
POST /api/agents/{id}/files
GET  /api/agents/{id}/system-files/{name}
PUT  /api/agents/{id}/system-files/{name}

POST /api/chat/stream
GET  /api/chat/subscribe
GET  /api/chat/history
GET  /api/chat/sessions

GET  /api/providers
POST /api/providers
PUT  /api/providers/{id}
DELETE /api/providers/{id}

GET  /api/apikeys
POST /api/apikeys
POST /api/apikeys/{id}/rotate
DELETE /api/apikeys/{id}

Admin APIs

Admin-only paths include users, cross-tenant agent views, chats, tasks, registration settings, plugins, tools, and skill deletion:

GET  /api/users
POST /api/users
PUT  /api/users/{id}
DELETE /api/users/{id}
GET  /api/tasks
GET  /api/plugins
PUT  /api/plugins/{id}
GET  /api/tools
PUT  /api/tools

Health

GET /healthz
GET /livez
GET /readyz

OpenAI-Compatible

App User Provisioning

Dashboard APIs

Admin APIs

Health

On this page