Overview

Authentication

Authenticate requests to the Builder API using an admin API key or publishable key for public query endpoints.

Authentication

Most Builder API endpoints require an admin API key. Pass it as a bearer token or query parameter.

header

Authorizationstring

Required

Bearer token. Format: Bearer YOUR_ADMIN_KEY.

query

admin_keystring

Alternative to the header for server-to-server or tooling scenarios. Do not expose in client-side code.

Public query endpoint

The POST /public/query endpoint accepts a client publishable key instead of an admin key. This allows client-side dashboards to query their own data.

header

X-Publishable-Keystring

Required

Client publishable key. Format: pk_.... Scopes the query to the associated client.

Never expose the admin key in client-side JavaScript, public repositories, or logs. Use the publishable key for client-facing dashboards.

Was this page helpful?

Built with Documentation.AI

Last updated today