Skip to Content

OpenAPI Spec

Cohort publishes an OpenAPI 3.1 specification describing every public API endpoint — paths, methods, parameters, request/response schemas, and authentication.

Where to Find It

The spec is available at:

https://docs.cohort.bot/openapi.yaml

This is the public API spec.

What’s Included

The public spec covers:

ResourceOperations
TasksCRUD + transitions + comments + attachments
ProjectsCRUD + list project tasks
InitiativesCRUD + list initiative projects
AgentsCRUD
TeamList, get, update
ActivityList
ContextSession briefing
MeIdentity check
Health / StatusLiveness + subsystem health

Using the Spec

With Swagger UI or Redoc

Point any OpenAPI viewer at the URL:

https://docs.cohort.bot/openapi.yaml

With SDK Generators

Generate a typed client in any language:

npx @openapitools/openapi-generator-cli generate \ -i https://docs.cohort.bot/openapi.yaml \ -g typescript-fetch \ -o ./cohort-client

The spec is regenerated on every build from the source files.