Public API
Base URL:
- Local:
http://127.0.0.1:3200 - QA:
https://api.qa.clankership.net - Production:
https://api.clankertest.com
Auth: Authorization: Bearer ctk_… or X-API-Key: ctk_… from a key created on the website (Security settings). Dedicated CLI OAuth bearer tokens also work. Account API keys use their assigned workspace role. Production pull requires a separate scoped vault key; see Secrets vault and CLI. MCP uses a separate agent OAuth access token.
The website does not call this API. Agents and other HTTP clients do. Permission checks live in @clanker/services.
Every web action
| UI | HTTP |
|---|---|
| API keys | GET/POST /v1/api-keys, POST /v1/api-keys/{id}/revoke |
| Profile and photo | GET/PATCH /v1/me, POST /v1/me/photo |
| Notifications | GET/PATCH /v1/me/preferences |
| Home / onboarding | GET /v1/me/home, GET /v1/me/onboarding |
| Workspaces | GET/POST /v1/workspaces, GET/PATCH /v1/workspaces/{slug} |
| Slug check | GET /v1/slugs/{slug}, GET /v1/workspaces/{slug}/slug-availability?slug= |
| Icon | POST /v1/workspaces/{slug}/icon |
| Members | GET /v1/workspaces/{slug}/members, PATCH/DELETE .../members/{userId} |
| Invites | GET/POST .../invites, revoke/resend/role, GET/POST /v1/invites/{token} |
| Teams | GET/POST .../teams, rename/delete/members |
| Events / people / seeds | GET .../events, .../people, .../seeds, POST /v1/seeds/{id}/join |
| Agents | GET .../agents?person=me, POST .../agents/{id}/revoke |
| Products | GET/POST .../products, GET/PATCH .../products/{product}, archive/restore |
| Environments | GET/POST .../environments, GET/PATCH .../environments/{environment}, archive/restore |
| Deployments | GET/POST .../deployments, GET/PATCH/DELETE .../deployments/{product}/{environment} |
Google OAuth, email sign-in, and password reset remain on the website only.
Machine-readable:
GET /openapi.json- Docs
llms.txt,llms-full.txt,AGENTS.md,index.json
Products, environments and deployments are documented in Products and environments. Versioned secrets, bulk assignment, restore, account keys and vault keys are documented in Secrets vault and CLI.