SDKs & clients

Generate a typed client from the OpenAPI spec, or call the API directly.

The API is described by a single OpenAPI 3.1 document, so you can generate a typed client in any language — no hand-written SDK required.

Generate a client

The spec powers the interactive "Try it" panels and is the source of truth for codegen. Point any OpenAPI generator at it:

# example: TypeScript client with openapi-typescript
npx openapi-typescript <openapi-url> -o well-api.d.ts

# example: full client with openapi-generator
openapi-generator-cli generate -i <openapi-url> -g typescript-fetch -o ./well-client

Call it directly

Every request needs a bearer token (see Authentication) and follows the JSON:API conventions. Each endpoint page includes copy-paste cURL plus a live request console.

MCP

If you are building an AI agent, the MCP server exposes the same data through tool calls (well_query_records, well_get_schema) — often a better fit than raw REST for LLM clients.