Skip to content

Documentation · API

Control-plane API reference

The control-plane API exposes the stable core contract used to inspect and administer an Olivares AI engine. The module surface is published separately as a beta route inventory.

39

stable paths

60

stable operations

10

stable tags

Authentication and tenancy

Send an opaque bearer token: a console session token beginning olvs_ or an API token beginning olvk_. A token can bind its tenant; otherwise pass X-Olivares-Tenant when the principal can act in more than one tenant. 

curl --request GET 'https://your-olivares.example/v1/agents' \
  --header 'Authorization: Bearer olvk_…' \
  --header 'X-Olivares-Tenant: YOUR_TENANT_ID'

This example uses the published GET /v1/agents operation.

Two contract tiers

Stable core

Published contract

The core specification is the stable API tier. The product is pre-1.0: its 24-month deprecation window is a commitment that binds from the 1.0/GA release, not a support window already in force.

Download stable OpenAPI JSON

Beta modules

Module route inventory

Beta routes may change with notice and are NOT covered by the 24-month stable window of the core contract. The beta specification enumerates routes and permissions without inventing request or response semantics.

463 paths · 616 operations · 30 namespaces

Browse modules Download beta OpenAPI JSON

Stable API by tag