Try Opteryx

API Reference

This section documents the HTTP APIs exposed by Opteryx services.

Generated from OpenAPI

  • Authentication API — Authentication, OAuth 2.0, OpenID Connect discovery, JWKS publication, and client credential management.
  • Control API — Billing accounts and membership, payment methods and invoices, workspace lifecycle and catalogs, and the notification feed behind the Studio bell. Access policies are granted in SQL rather than here — see GRANT and REVOKE.
  • Jobs API — Job submission, execution status tracking, result retrieval, recent-query listing, and edit-time statement checking.
  • OData API — OData service discovery, metadata, and dataset query endpoints for compatible clients and BI tools.
  • Upload API — Agree the column types before any data is sent, then upload files against that agreement and commit them as one snapshot.