app_…) for device and browser flows and a confidential M2M client (m2m_…) for server-to-server calls. Read Client model first if this is new to you.
Start here
Quickstart
Provision a user and mint a scoped JWT in under ten minutes.
Client model
Understand public vs M2M clients, API keys, scopes, and the billing pattern before writing any code.
Builder SDK
TypeScript client for the Builder API, OIDC issuer, and signer integration. Install in one line.
API keys
Long-lived pmth_* keys for per-user and app-level integrations. Exchange for short-lived JWTs on demand.
Authentication
Choose the authentication pattern that matches your integration:Machine access
Client credentials grant and HTTP Basic auth for server-to-server calls.
Interactive login
Authorization code flow with PKCE for browser and server-side web apps.
Device flow
RFC 8628 device authorization for CLI tools, set-top boxes, and limited-input devices.
Token exchange
RFC 8693 token exchange for device completion, signer sessions, and Option A clearinghouse mint.
Builder API
User management
Create, upsert, update, and deactivate users. Manage per-user API keys and subscriptions.
User-scoped JWTs
Mint short-lived access tokens scoped to a specific end-user and capability.
Allowances
Per-user USD micro entitlement balances. Read, grant top-ups, and check real-time access.
Signer routing
Direct DMZ proxy, identity webhook, and go-livepeer integration patterns.
Usage and billing
Usage API
Aggregate request counts and fee totals. Group by user, pipeline/model, or daily windows. OpenMeter-backed.
Billing summary
Single-call snapshot: plan, subscription, usage totals, daily timeline, overage, and USD breakdowns.
Plans
Create, update, sync, and manage billing plans. Includes billing API v2 and Starter plan.
Migration
Deprecated routes
Migration guide for removed endpoints: signer proxy (410), synchronous ingest (410), and deprecated credits/subscriptions.
Discovery
All endpoint paths are published via OIDC discovery. Always read endpoints from the discovery document at runtime so your integration tracks rotations automatically:http://localhost:3001/api/v1/oidc.