Skip to main content

API Key authentication

All API requests are authenticated using an API key. Generate one from the Orova dashboard and include it in the x-api-key header:

Create an API key

1

Sign in to the dashboard

Go to app.orova.ai and sign in.
2

Navigate to API Keys

Go to Settings → API Keys.
3

Create a key

Click Create API Key and give it a descriptive name.
4

Copy the key

Copy the key immediately — it’s only shown once.
Keep your API key secret. Don’t expose it in client-side code (except the widget’s data-api-key attribute). Use it only in server-to-server requests.

Using the API key

Include it in every request as a header:
Or in the embeddable widget:

Workspace isolation

All data is scoped to a workspace. Include workspaceId as a query parameter or in the request body when needed: