OpenAPI Reference
Browse the Parix HTTP API—authenticate, call endpoints, and open the live OpenAPI document.
The Parix customer API is versioned under /api/v1. Use it to check credentials, discover create options, manage databases, and run supported TigerBeetle operations through the Parix gateway.
This section is an interactive reference generated from the OpenAPI schema. For step-by-step integration guidance, see API and OpenAPI.
Base URL
Production:
https://parix.ioExample request path:
https://parix.io/api/v1/sessionUse the same origin that issued the credential and owns the databases you call. Credentials and database IDs are not interchangeable across environments.
Authenticate
Send exactly one of these headers:
x-api-key: px_...Authorization: Bearer <access-token-or-api-key>Create or rotate keys in the dashboard under Settings → API keys. Organization owners and administrators can manage keys. A new or rotated secret is shown once—store it in a secret manager.
| Credential | Boundary |
|---|---|
| All-databases API key | Organization-wide lifecycle and database access in that organization |
| Specific-database API key | One database UUID only |
| OAuth / CLI access token | Membership and granted scopes (db:read, db:write) |
Start every new integration by confirming the credential:
curl "https://parix.io/api/v1/session" \
-H "x-api-key: $PARIX_API_KEY"A successful response returns authentication type, organization, scopes, and—when applicable—the key’s database boundary.
Authoritative schema
| Source | Use it for |
|---|---|
Live OpenAPI 3.1 document: /api/v1/openapi.json | Client generation, request validation, and the current contract |
| This interactive reference | Browsing operations and schemas in the docs UI |
The interactive pages render a bundled schema snapshot and can lag the live route until the bundle is regenerated. Prefer /api/v1/openapi.json from production when schemas must match runtime.
Resource map
Browse the sidebar, or jump to a group:
| Group | What it covers |
|---|---|
| Session | Confirm credential, organization, and scopes |
| Catalog | Create options currently available to the organization |
| Databases | List, create, inspect, and delete databases |
| TigerBeetle | Gateway operations: create/lookup/query accounts and transfers |
Common lifecycle routes:
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/session | Validate the credential |
GET | /api/v1/catalog/create | Discover create options |
POST | /api/v1/databases | Create or queue a database |
GET | /api/v1/databases | List databases |
GET | /api/v1/databases/{databaseId} | Inspect one database |
DELETE | /api/v1/databases/{databaseId} | Queue deletion |
POST | /api/v1/databases/{databaseId}/tb/{operation} | Run a TigerBeetle operation |
Database create and delete are asynchronous. A successful accept response does not mean infrastructure is ready—poll database or job status until the work finishes. See Database statuses.
Related guides
- API and OpenAPI — full integration how-to
- API keys — create and scope keys
- Gateway — request path, errors, and retries
- TigerBeetle operations — supported TB operations and payloads
- API keys and authentication — 401/403 troubleshooting