Skip to content

API changelog

The API is versioned in the path (/v1). Additive changes (new operations, optional inputs, response fields, enum values, error codes, scopes) ship in /v1 and are listed here. A breaking change only ships in a new major version, announced with Deprecation and Sunset headers at least six months ahead (Versioning).

2026-10-23. Documentation and additive changes only; no client change is needed.

  • GET /v1/review-items: optional libraryId (one library; the default library otherwise; unknown or out of scope → 404). GET /v1/knowledge/health: libraryId in the response.
  • Library-scoped reads follow one rule: GET /v1/documents, GET /v1/review-items and GET /v1/knowledge/health work on one library — libraryId or the organization’s default library. Every organization has exactly one library today, so no response changes.
  • Error responses are documented per status: each lists the codes it can return (an error.code enum) with an example per code, instead of one generic example. INSUFFICIENT_SCOPE, API_DISABLED and IDEMPOTENCY_CONFLICT describe what they do (Errors).
  • Corrections: uploads over 25 MB answer 400 VALIDATION_ERROR (413 was never returned and is no longer listed); POST /v1/ask never answers 402 (it falls back to the approved answer); POST /v1/documents and POST /v1/ask list 409 (IDEMPOTENCY_CONFLICT, and LIBRARY_ARCHIVED for library writes).
  • The description’s contact link and the discovery documents point at these docs, https://tradecrafthub.ai/docs/api/.

2026-10-22. Available when api.tradecrafthub.ai launches.

  • First published version: accounts (/v1/me); assessments (list, get, questions, download, upload, Analyze, Process); review (question edits, regenerate, Send to Finalize, Finalize — people only); knowledge (answers, proposals and edits — always pending review, gaps and gap answers, libraries, topics, health, ask); documents (list, get, add, versions, download); the review queue (read-only); and audit events (audit:read).
  • OAuth 2 on one issuer, https://api.tradecrafthub.ai: authorization code with PKCE (S256) and client credentials; 13 scopes.

Privacy preference center

When you visit tradecrafthub.ai, we store or read a small number of cookies in your browser. Strictly necessary cookies make the website and the Tradecraft app work. Analytics cookies are used only if you allow them. Open a category to learn more, and see our privacy policy for how we handle the information you enter on this site.

Manage consent preferences

  • Always active