Skip to main content
All requests to the Valuez External Developer API and Integration APIs require an API key. Your workspace administrator will provision and share this key with you before you begin development. Production Base URL: https://api.dashboard.valuez.ai

1. How Authentication Works

Every API request must include the following HTTP header:
  • Header Name: x-api-key
  • Key Format: valuezai_api_<ID>_<secret> (e.g. valuezai_api_12_a8f3b2c9d4e5...)
  • Scope & Credits: Each key is bound to your workspace, specific permission scopes, and an optional credit usage limit.

2. Getting Your API Key

API keys are provisioned and managed by your workspace administrator. Contact your admin to receive:
  1. Your API key (valuezai_api_...) — required for all API requests.
  2. Confirmation of which permission scopes your key covers (see §5 below).
Once you have the key, store it as an environment variable in your backend. Never hard-code it in source files.
Treat your API key like a password. If a key is accidentally exposed, notify your admin immediately so it can be rotated.

3. Configuring Postman

Your admin will also share the Valuez External Developer API Postman collection and ValuezAI_REST_API environment. After importing them, set these two environment variables:
The Postman collection is pre-configured with x-api-key: {{APIKey}} at the collection level. All requests inherit this automatically — no manual header setup needed for any endpoint.

4. Code Examples

Use the following examples to make your first authenticated API call (listing agents in your workspace):

5. Permission Scopes

When your admin provisions a key, it is assigned specific permission scopes. If a request touches an endpoint outside the key’s allowed scopes, the server returns 403 Forbidden.

6. Common Authentication Errors

Look up IDs

Query master values before creating agents or campaigns.

Speech & Agent APIs

Start sending questions and synthesizing speech.

Agents & Knowledge

Create and configure your first AI agent.

Manage workspace API keys in the dashboard

  1. Open Settings & Billing → API Access as a workspace administrator with access to key management.
  2. Create a key, give it a descriptive name, and select the modules and permissions the integration needs.
  3. Copy the full key when it is revealed and store it securely on the server that will use it. The dashboard displays the full value once, at creation. Send the key in the x-api-key header.
  4. To retire a key, find it in API Access, select Revoke, and confirm. Update any dependent integration to use a replacement key before revoking the old one.
Use API Access for scoped workspace developer keys. For agent and speech keys, follow Integrations.