Create an API key

POST

api-keys

Create an API key

curl --request POST \
  --url https://api.voice.wixzel.com/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [],
  "spend_limit_micros": 194000,
  "expires_at": "2026-09-01T12:00:00.000Z"
}
'

import requests

url = "https://api.voice.wixzel.com/v1/api-keys"

payload = {
    "name": "<string>",
    "scopes": [],
    "spend_limit_micros": 194000,
    "expires_at": "2026-09-01T12:00:00.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    scopes: [],
    spend_limit_micros: 194000,
    expires_at: '2026-09-01T12:00:00.000Z'
  })
};

fetch('https://api.voice.wixzel.com/v1/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voice.wixzel.com/v1/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'scopes' => [
        
    ],
    'spend_limit_micros' => 194000,
    'expires_at' => '2026-09-01T12:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voice.wixzel.com/v1/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.voice.wixzel.com/v1/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "api_key",
  "name": "<string>",
  "prefix": "wv_live_",
  "last4": "<string>",
  "scopes": [
    "agents:read"
  ],
  "spend_limit_micros": 194000,
  "last_used_at": "2026-09-01T12:00:00.000Z",
  "expires_at": "2026-09-01T12:00:00.000Z",
  "created_at": "2026-09-01T12:00:00.000Z",
  "key": "wv_live_xxxxxxxxxxxxxxxxxxxxxx_ab12"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Body

application/json

name

string

required

For your own reference, e.g. "production backend".

Required string length: 1 - 200

scopes

enum<string>[]

required

Grant only what the key needs. There is no admin scope.

Minimum array length: 1

Available options:

agents:read,

agents:write,

calls:read,

calls:write,

leads:read,

leads:write,

campaigns:read,

campaigns:write,

knowledge_bases:read,

knowledge_bases:write,

phone_numbers:read,

phone_numbers:write,

sip_trunks:read,

sip_trunks:write,

appointments:read,

appointments:write,

webhooks:read,

webhooks:write,

usage:read,

billing:read

spend_limit_micros

integer

Micro-USD. 1_000_000 = $1.00.

Example:

194000

expires_at

string<date-time>

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

Response

The new key, including its secret

string

required

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

object

enum<string>

required

Available options:

api_key

name

string

required

prefix

string

required

Example:

"wv_live_"

last4

string

required

scopes

enum<string>[]

required

Available options:

agents:read,

agents:write,

calls:read,

calls:write,

leads:read,

leads:write,

campaigns:read,

campaigns:write,

knowledge_bases:read,

knowledge_bases:write,

phone_numbers:read,

phone_numbers:write,

sip_trunks:read,

sip_trunks:write,

appointments:read,

appointments:write,

webhooks:read,

webhooks:write,

usage:read,

billing:read

spend_limit_micros

integer | null

required

Guardrail, enforced within about a minute. Not a hard cap.

Example:

194000

last_used_at

string<date-time> | null

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

expires_at

string<date-time> | null

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

created_at

string<date-time>

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

key

string

required

The secret. Shown once and never again — store it now.

Example:

"wv_live_xxxxxxxxxxxxxxxxxxxxxx_ab12"

⌘I

Create an API key

curl --request POST \
  --url https://api.voice.wixzel.com/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [],
  "spend_limit_micros": 194000,
  "expires_at": "2026-09-01T12:00:00.000Z"
}
'

import requests

url = "https://api.voice.wixzel.com/v1/api-keys"

payload = {
    "name": "<string>",
    "scopes": [],
    "spend_limit_micros": 194000,
    "expires_at": "2026-09-01T12:00:00.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    scopes: [],
    spend_limit_micros: 194000,
    expires_at: '2026-09-01T12:00:00.000Z'
  })
};

fetch('https://api.voice.wixzel.com/v1/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voice.wixzel.com/v1/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'scopes' => [
        
    ],
    'spend_limit_micros' => 194000,
    'expires_at' => '2026-09-01T12:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voice.wixzel.com/v1/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.voice.wixzel.com/v1/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"scopes\": [],\n  \"spend_limit_micros\": 194000,\n  \"expires_at\": \"2026-09-01T12:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "api_key",
  "name": "<string>",
  "prefix": "wv_live_",
  "last4": "<string>",
  "scopes": [
    "agents:read"
  ],
  "spend_limit_micros": 194000,
  "last_used_at": "2026-09-01T12:00:00.000Z",
  "expires_at": "2026-09-01T12:00:00.000Z",
  "created_at": "2026-09-01T12:00:00.000Z",
  "key": "wv_live_xxxxxxxxxxxxxxxxxxxxxx_ab12"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Getting started

Concepts

API reference

Authorizations

Body

Response