Ensure a connector token exists for an environment

Create a connector for one client environment (sandbox, pre-release or live) if none exists, and return its token.

Safe to call repeatedly: if the environment already has a connector, its existing token is returned unchanged. No request body is needed.

The connector token is the per-environment credential a telephony or websocket integration presents so PolyAI routes the call to this agent in that environment. SIP integrations pass it as X-PolyAi-Auth-Token in the SIP URI and websocket integrations pass it as the X-PolyAi-Auth-Token custom parameter. It is not an API key. Treat it as a secret.

PUT

agents

{agentId}

telephony

connector-tokens

{clientEnv}

Ensure a connector token exists for an environment

curl --request PUT \
  --url https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}', 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.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "clientEnv": "sandbox",
  "connectorId": "<string>",
  "token": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

agentId

string

required

clientEnv

string

required

Response

Successful response

The connector token for one client environment.

clientEnv

enum<string>

required

Client environment the token routes calls to

Available options:

sandbox,

pre-release,

live

connectorId

string

required

ID of the connector the token belongs to

token

string

required

Connector token. Treat as a secret; it grants call access to this agent in this environment.

Last modified on November 5, 2026

⌘I

Ensure a connector token exists for an environment

curl --request PUT \
  --url https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}', 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.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/telephony/connector-tokens/{clientEnv}")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "clientEnv": "sandbox",
  "connectorId": "<string>",
  "token": "<string>"
}

API reference

Models

Build & deploy

Runtime & data

Monitoring

Legacy

Ensure a connector token exists for an environment

Authorizations

Path Parameters

Response