SDKs
API client
Generated TypeScript client and runtime configuration.
@zitadel/api is generated from the OpenAPI source under api/openapi/.
It exposes:
- generated endpoint functions
- generated models
- Zod schemas
- MSW helpers
- runtime helpers for base URL and auth
Install
pnpm add @zitadel/apinpm install @zitadel/apiyarn add @zitadel/apiUsage
Use the API reference to inspect endpoint shapes. Use package exports from @zitadel/api when writing CLI, SDK, or app code against the typed client.
Edit the OpenAPI source
Do not hand-edit generated API package output. Update api/openapi/** and regenerate through the repo tasks.
API reference
Generated endpoint docs grouped by OpenAPI tags.
Sessions
Session lifecycle and session-token endpoints.
Auth attempts
Ephemeral authentication state machine endpoints.
See also
- API reference — every endpoint, generated from the same OpenAPI source.
@zitadel/apisource and the OpenAPI spec.