Skip to content
RoveldiRoveldiProvenant documentation

API overview

Where the reference comes from

Section titled “Where the reference comes from”

The API reference is generated from Provenant’s OpenAPI document. Only operations approved as part of the public API are published; internal and administrative routes are never included.

Authentication

Section titled “Authentication”

Requests authenticate with an API key sent in a request header. The reference shows the exact header for each operation.

  • Keys are scoped to one tenant and one environment.
  • Treat a key like a password: never put it in source code, tickets or chat.

Try it

Section titled “Try it”

The reference includes a “Try it” console. It sends requests only to the Provenant sandbox, which holds synthetic data, using a sandbox API key you enter. The documentation site’s security policy blocks requests to any other API, so “Try it” cannot reach production or customer data.

Read Sandbox and API keys before you use it.