Skip to main content
The Work API is the HTTP API behind Work: boards, items, columns, automations, gates, agents, members and the rest. The pages under Work API reference list every operation with its parameters, request body and responses.

​
Where it lives

  • Base URL: https://boardy.worksong.ai. Everything is under /v1.
  • The contract: /v1/openapi.json is the OpenAPI 3.1 document, and /v1/reference is an interactive viewer. The reference here is that document for the released version named at the top of the file.
  • Version: GET /health returns the running release, for example 1.2.6.

​
Authentication

Send Authorization: Bearer <token>. Two kinds of token work:
  • an API token (bdy_…) for integrations. It acts as the Member it is bound to, limited by the token’s scope.
  • a Clerk session token, which is what the apps use. It resolves the workspace from the active organization.
Every change goes through one boundary that checks authority, gates and limits, writes the audit record, and only then does the work. See Automations, Gates and Agents.

​
Writes and conflicts

  • A mutation takes an Idempotency-Key header. Repeating a call with the same key replays the first result.
  • A conflicting edit answers 409 with a conflict token. Read the item again and decide; do not treat it as fatal.
  • Errors are application/problem+json (RFC 9457).
Source: worksong-ai/Boardy:src/Boardy.Api/Program.cs@6775786, worksong-ai/Boardy:CLAUDE.md@6775786. Docs version: Worksong 2.0 with Work 1.2.