The full machine-readable contract for the CrewPass Partner API is generated directly from the service by FastAPI, so it never drifts from the running code.
  • Endpoints tab — the interactive reference (request/response schemas, examples, the “try it” playground) is generated from the OpenAPI document.
  • Raw spec — openapi.json and openapi.yaml. Feed either to a coding agent to generate a client.
  • Live spec — the running API serves the same document at https://partners.crewpass.co.uk/openapi.json.

​
Security

Every /api/v2/* read requires the PartnerApiKey bearer scheme (your cpk_live_* / cpk_test_* key), presented as a Bearer token over TLS. Reads are not signed, so the OpenAPI playground’s bearer-token field is all a live read needs. See Authentication. Request signing (HMAC) returns for the v2 write surface, which is currently disabled.

​
For AI agents

  • /llms.txt — curated manifest of every page.
  • /llms-full.txt — all docs concatenated into one file.
  • Every documentation page also resolves as .md.