Status
The engine is live. Sandbox is open to everyone. Live mode opens with our first design partners.
Every capability in these docs is labeled by what it is today. GET /protocol is the authoritative live map — its agent_self_serve block states the current sandbox/live posture, and if a doc ever gets ahead of the deployed engine, the engine wins.
Live todayInstant sandbox keys (self-serve signup, odk_sandbox_ prefix), public discovery on production (/search, /providers, /offers, availability, Sure Price), the full S0–S8 booking and payment state machine against a synthetic provider with simulated payments, SSE and webhooks, the MCP server, and the TypeScript SDK.Opening with first partnersLive-mode keys (odk_live_, granted per-partner), real provider inventory, real-money transactions, and Stripe Connect payouts. Nothing in these docs implies you can transact against live inventory today — when live mode opens for your key, the same routes and state machine carry over unchanged.Reference
Start with the protocol map.
The API reference is the contract. The protocol discovery endpoint is the runtime map. The health endpoint is only uptime telemetry.
OpenDoc Platform API
Rendered reference for taxonomy, providers, offers, Health Keys, transactions, consent, webhooks, and more.
Open reference OpenAPIOpenAPI v1.1 YAML
Machine-readable API contract for SDK generation, validation, and partner review.
Download spec RuntimeProtocol discovery
Live list of supported protocol capabilities, tool descriptors, route paths, and auth requirements.
Inspect endpointGuides
Build against the engine — in sandbox today.
These guides cover the current integration paths for SDK usage, discovery, delegated authority, cash-price transactions, provider activation, payouts, environments, PHI handling, error handling, testing, event delivery, and version changes. Discovery reads run against production; transaction flows run in sandbox until live mode opens for your key.
TypeScript SDK quickstart
Install the OpenDoc client, call public discovery routes, add agent tokens, and verify webhook signatures.
Open guide DiscoverySearch, offers, and availability
Use public search, provider, offer, availability, Sure Price, and clinical-route read paths before starting a transaction.
Open guide AuthAuthentication and delegated authority
Identity sessions, Health Keys, consent, agent-token grants, and Bearer-token usage.
Open guide TransactionsS0-S8 transaction flow
Declare intent, authorize, accept terms, commit, idempotency, and state readback.
Open guide ProvidersProvider onboarding
NPI prefill, claim roles, activation gates, bookable services, and availability.
Open guide AccessProvider access and verification
Provider/SCP role mapping, route permissions, verification gates, and activation authority.
Open guide PaymentsProvider payouts and Stripe Connect
Document the current payment boundary, provider account requirement, non-live mode, and later-scope payout work.
Open guide EventsSSE and webhooks
Event streams, webhook subscriptions, HMAC signatures, and delivery headers.
Open guide ErrorsErrors and idempotency
Standard error envelopes, correlation IDs, SDK error handling, and retry-safe keys.
Open guide AccessEnvironments and API access
Separate marketplace, docs, developer, and protocol origins, and keep secrets in managed stores.
Open guide SecuritySecurity and PHI handling
Keep PHI out of public discovery, logs, webhook payloads, and test fixtures unless a route explicitly requires it.
Open guide TestingTesting and proof stages
Production-safe smoke checks, synthetic data rules, state-changing test boundaries, and proof evidence.
Open guide VersionsChangelog and versioning
Track protocol, OpenAPI, SDK, docs, and deployment changes with explicit compatibility signals.
Open guideBase URL
The API is at api.opendoc.com.
opendoc.com is the marketplace website. api.opendoc.com is the backend protocol. The root API response is intentionally minimal; it points clients to documentation and keeps service details narrow.
opendoc.comPatient-facing marketplace and search experience.dev.opendoc.comDeveloper and partner onboarding.docs.opendoc.comTechnical reference and API docs.api.opendoc.comProduction protocol API.Route map
Core route families.
These are the current integration anchors. Some routes are public discovery; transaction and patient surfaces require identity/session or agent-token context.
GET /protocolCapability discovery and tool catalog.GET /searchSearch providers and services.GET /providersProvider directory and provider details.GET /offersProvider x HSO x location cash-price offers.POST /transactions/*Declare intent, authorize, accept terms, and commit.GET /healthOperational readiness check, not product discovery.