API reference

Every page in this section is generated from /openapi.json (OpenAPI 3.1) when the docs are built, one page per resource: events, customers, ledger (currencies, ledger entries and balances), rules, change sets and the rest in the sidebar. Each operation lists its credentials, scopes, parameters, request and response schemas and error codes.

Conventions

• The server URL is https://api.orishare.com/v1; every path in the reference is under it.
• JSON is snake_case and timestamps are RFC 3339 in UTC.
• Lists use cursor pagination: limit and cursor in, next_cursor and has_more out.
• Creating POST requests need an Idempotency-Key; send the same key only to repeat the same request.
• Edits are safe with ETag and If-Match.
• Errors have one shape with a stable code; Error codes lists every code with its status, type and retry class.

Credentials

Secret keys (osk_) are bound to one environment and stay on your server. Personal access tokens (opat_) manage organizations and name an environment with X-Orishare-Environment. Publishable keys (opk_) may only send the client events an environment allows. The agent guide says who holds each credential and where it may live; Customer sessions covers player-facing screens.