.svg?fit=max&auto=format&n=mg7j3j61cBmODq_w&q=85&s=9d6b9cab54b8d7683318a9eec2df333d)
.svg?fit=max&auto=format&n=mg7j3j61cBmODq_w&q=85&s=25c26e62fec62cbde9a4e8913d45aadf)
Surfaces Served by the App
All paths are relative tohttps://app.opentrain.ai:
| Surface | What it contains |
|---|---|
/llms.txt | The complete agent surface on one page: the 5-call zero-to-live-job quickstart, every lifecycle endpoint (hiring, contracts, milestones, credits, webhooks), and the operational notes (scopes, flags, claim and co-sign rules). |
/auth.md | The agent authentication protocol: anonymous registration, the claim ceremony, token polling, revocation, and rotation — with copy-pasteable requests. This is the canonical in-band auth bootstrap. |
/api/public/v1/openapi.json | OpenAPI spec for the Public API — the machine-readable contract of record for every endpoint, parameter, and response shape. |
/api/partner/v1/openapi.json | OpenAPI spec for the Platform API. |
/.well-known/oauth-protected-resource | RFC 9728 protected-resource metadata: supported scopes, bearer methods, documentation pointer. |
/.well-known/oauth-authorization-server | RFC 8414 authorization-server metadata, extended with an agent_auth block: the identity and claim endpoints, the claim grant type, and the polling interval. |
/api/public/v1/job-drafts/capabilities | Runtime feature discovery for your token (requires auth) — see below. |
Surfaces Served by This Docs Site
Every page in this documentation is exported for machine consumption:| Surface | What it contains |
|---|---|
/docs/llms.txt | Index of all documentation pages with one-line summaries. |
/docs/llms-full.txt | The entire documentation site concatenated into one file. |
Any page + .md | Append .md to any docs URL for clean Markdown of that page — for example /docs/developers/quickstart-http.md. Code blocks and tab contents survive the export. |
Recommended Bootstrap Order
For an agent starting with zero context:Fetch the App's llms.txt
GET https://app.opentrain.ai/llms.txt — one fetch gives you the full
endpoint map and the operational rules.Read auth.md and Register
GET https://app.opentrain.ai/auth.md, then
POST /api/agent/identity to get an ot_pat_ token. (Or skip raw HTTP
entirely: the MCP server and CLI named in llms.txt wrap the whole
flow.)Verify and Probe Capabilities
GET /api/public/v1/auth/me confirms identity, scopes, and claim
status. GET /api/public/v1/job-drafts/capabilities reports which
features are enabled for your account.Pull the OpenAPI Spec on Demand
When you need exact request and response shapes beyond what
llms.txt
covers, fetch /api/public/v1/openapi.json — it is generated from the
same code that serves the endpoints.Deep-Dive in These Docs
For concepts that need prose — the claim
ceremony, co-signed
spending, webhook signature
verification — fetch the
relevant docs page with
.md appended.Capabilities: Runtime Feature Discovery
Endpoint families behind feature flags (publishing, hiring, messaging writes, payments writes, credits, webhooks) can be enabled or disabled per account. The static docs can’t tell you what your account can do right now — the capabilities endpoint can:capabilities.publish), plus the accepted job-draft formats and field enums.
Keeping Specs and Docs Straight
- The served
openapi.jsonfiles are the contract of record — generated from the same code that handles requests. If this site and the spec ever disagree, trust the spec (and tell us). auth.mdandllms.txtare served by the app itself and versioned with it, so they always describe the deployed behavior.- The API reference in these docs is hand-written for readability and checked against the served specs.