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:- Your API key (
valuezai_api_...) — required for all API requests. - Confirmation of which permission scopes your key covers (see §5 below).
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: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 returns403 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
- Open Settings & Billing → API Access as a workspace administrator with access to key management.
- Create a key, give it a descriptive name, and select the modules and permissions the integration needs.
- 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-keyheader. - 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.
