Skip to main content
The Operark API is organized around predictable, resource-oriented URLs and standard HTTP semantics. Every endpoint on the following pages is generated directly from the OpenAPI specification, so it stays in step with the platform.

​
Base URL

Use http://localhost:3001 when developing against a local instance.

​
Surfaces

​
Conventions

  • Authentication — Authorization: Bearer YOUR_API_KEY on every request. See Authentication.
  • Content type — request and response bodies are JSON.
  • Pagination — list endpoints are paginated; follow the returned cursors.
  • Errors — a consistent envelope with a machine-readable code. See Authentication → Errors.
  • Idempotency — retried 5xx failures are safe for idempotent operations.

Quickstart

New here? Make your first call in five minutes.