Set the voice source (saved config link) for an assistant

PUT

voice

assistants

{agent_id}

voice-config-source

Set the voice source (saved config link) for an assistant

curl --request PUT \
  --url https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source"

payload = { "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({saved_config_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source', 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-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'saved_config_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source"

	payload := strings.NewReader("{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.put("https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "elevenlabs",
    "external_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "preview_url": "<string>",
    "language": "<string>",
    "accent": "<string>",
    "category": "<string>",
    "labels": {},
    "supported_models": [
      "<string>"
    ],
    "is_active": true
  },
  "stt_provider": "<string>",
  "stt_language": "<string>",
  "vad_provider": "<string>",
  "interruption_sensitivity": 123,
  "min_endpoint_delay_ms": 123,
  "max_endpoint_delay_ms": 123,
  "preemptive_generation_enabled": true,
  "noise_cancellation_enabled": true,
  "noise_cancellation_provider": "rnnoise",
  "normalize_for_speech": true,
  "audio_in_sample_rate": 123,
  "audio_out_sample_rate": 123,
  "metrics_enabled": true,
  "usage_metrics_enabled": true,
  "language": "<string>",
  "multilingual_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source": "inline",
  "has_inline_fallback": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_tuning": {},
  "stt_model": "<string>",
  "stt_provider_data": {},
  "tts_speed": 123,
  "tts_provider_data": {},
  "vad_provider_data": {},
  "local_vad_params": {},
  "turn_analyzer_params": {},
  "hard_turn_timeout_ms": 123,
  "end_call_phrases": [
    "<string>"
  ],
  "pronunciation_overrides": {},
  "heartbeats_period_secs": 123,
  "idle_pipeline_timeout_ms": 123,
  "locale": "<string>",
  "multilingual_languages": [
    "<string>"
  ],
  "linked_agent_count": 0,
  "linked_agent_names": [
    "<string>"
  ],
  "linked_team_count": 0,
  "linked_team_names": [
    "<string>"
  ],
  "metadata_": {},
  "first_speaking_config": {
    "first_speaker": "agent",
    "mode": "static",
    "text": "<string>",
    "instructions": "<string>",
    "interruptible": true,
    "ai_disclosure_text": "<string>"
  },
  "warnings": [
    "<string>"
  ],
  "effective_stt_model": "<string>",
  "effective_stt_provider_data": {},
  "effective_tts_model": "<string>",
  "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

agent_id

string<uuid>

required

Body

application/json

Request body for setting an agent's voice source.

saved_config_id is the id of a saved (named) voice config to link, or None to unlink (falling back to inline config).

saved_config_id

string<uuid> | null

Response

Successful Response

Config response for an agent, augmented with source metadata.

source is "saved" when the agent references a saved config via Agent.voice_config_id, or "inline" when using its own 1:1 row. saved_config_id is the id of the linked saved config, if any. has_inline_fallback reports whether an agent-owned inline row exists; the UI uses it to know whether unlinking is safe (the agent falls back to its preserved inline config) or would leave the agent with no voice config.

string<uuid>

required

voice_id

string<uuid>

required

voice

VoiceOut · object

required

Show child attributes

stt_provider

string

required

stt_language

string

required

vad_provider

string

required

interruption_sensitivity

number

required

min_endpoint_delay_ms

integer

required

max_endpoint_delay_ms

integer

required

preemptive_generation_enabled

boolean

required

noise_cancellation_enabled

boolean

required

noise_cancellation_provider

enum<string>

required

Noise-suppression engine wired by audio_filters.build_audio_in_filter.

Applies only when noise_cancellation_enabled. String values MUST match the provider strings the factory dispatches on.

Available options:

rnnoise,

dtln

normalize_for_speech

boolean

required

audio_in_sample_rate

integer

required

audio_out_sample_rate

integer

required

metrics_enabled

boolean

required

usage_metrics_enabled

boolean

required

language

string

required

multilingual_enabled

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

source

enum<string>

required

Available options:

inline,

saved

has_inline_fallback

boolean

required

organization_id

string<uuid> | null

name

string | null

agent_id

string<uuid> | null

team_id

string<uuid> | null

persona_id

string<uuid> | null

voice_tuning

Voice Tuning · object

stt_model

string | null

stt_provider_data

Stt Provider Data · object

tts_speed

number | null

tts_provider_data

Tts Provider Data · object

vad_provider_data

Vad Provider Data · object

local_vad_params

Local Vad Params · object

turn_analyzer_params

Turn Analyzer Params · object

hard_turn_timeout_ms

integer | null

end_call_phrases

string[]

pronunciation_overrides

Pronunciation Overrides · object

Show child attributes

heartbeats_period_secs

integer | null

idle_pipeline_timeout_ms

integer | null

locale

string | null

multilingual_languages

string[]

linked_agent_count

integer

default:0

linked_agent_names

string[]

linked_team_count

integer

default:0

linked_team_names

string[]

metadata_

Metadata · object

first_speaking_config

FirstSpeakingConfig · object | null

Config for the AI's opening turn (no user input yet).

Lives inside ChannelConfig — first-speaking is per-channel.

Mode-agnostic fields:

first_speaker: "agent" opens the call with the rendered message; "user" skips the greeting (caller speaks first). Non-voice channels treat the inbound user message as the "user" opener and ignore this field at runtime.

Greeting source (only applies when first_speaker="agent"):

static mode: text is required and emitted verbatim (templated via the shared {{var}} engine, src.shared.templating.render).
dynamic mode: instructions are sent to the model router with the agent persona to render an opening line (instructions are templated). When omitted/empty, instructions falls back to DEFAULT_DYNAMIC_FIRST_SPEAKING_INSTRUCTIONS so operators who just want a generic friendly opener don't have to author copy.

Voice-only fields (ignored on non-audio channels):

interruptible: whether the caller can barge in mid-greeting.
ai_disclosure_text: regulatory disclosure (e.g. CA SB 1001), played as an uninterruptible TTS frame BEFORE the greeting. Disclosure plays even when first_speaker="user" because the regulation requires the disclosure regardless of who speaks first.

Show child attributes

warnings

string[]

effective_stt_model

string | null

effective_stt_provider_data

Effective Stt Provider Data · object | null

effective_tts_model

string | null

saved_config_id

string<uuid> | null

Set the voice source (saved config link) for an assistant

curl --request PUT \
  --url https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source"

payload = { "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({saved_config_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source', 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-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'saved_config_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source"

	payload := strings.NewReader("{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.put("https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/voice/assistants/{agent_id}/voice-config-source")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"saved_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "elevenlabs",
    "external_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "preview_url": "<string>",
    "language": "<string>",
    "accent": "<string>",
    "category": "<string>",
    "labels": {},
    "supported_models": [
      "<string>"
    ],
    "is_active": true
  },
  "stt_provider": "<string>",
  "stt_language": "<string>",
  "vad_provider": "<string>",
  "interruption_sensitivity": 123,
  "min_endpoint_delay_ms": 123,
  "max_endpoint_delay_ms": 123,
  "preemptive_generation_enabled": true,
  "noise_cancellation_enabled": true,
  "noise_cancellation_provider": "rnnoise",
  "normalize_for_speech": true,
  "audio_in_sample_rate": 123,
  "audio_out_sample_rate": 123,
  "metrics_enabled": true,
  "usage_metrics_enabled": true,
  "language": "<string>",
  "multilingual_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source": "inline",
  "has_inline_fallback": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_tuning": {},
  "stt_model": "<string>",
  "stt_provider_data": {},
  "tts_speed": 123,
  "tts_provider_data": {},
  "vad_provider_data": {},
  "local_vad_params": {},
  "turn_analyzer_params": {},
  "hard_turn_timeout_ms": 123,
  "end_call_phrases": [
    "<string>"
  ],
  "pronunciation_overrides": {},
  "heartbeats_period_secs": 123,
  "idle_pipeline_timeout_ms": 123,
  "locale": "<string>",
  "multilingual_languages": [
    "<string>"
  ],
  "linked_agent_count": 0,
  "linked_agent_names": [
    "<string>"
  ],
  "linked_team_count": 0,
  "linked_team_names": [
    "<string>"
  ],
  "metadata_": {},
  "first_speaking_config": {
    "first_speaker": "agent",
    "mode": "static",
    "text": "<string>",
    "instructions": "<string>",
    "interruptible": true,
    "ai_disclosure_text": "<string>"
  },
  "warnings": [
    "<string>"
  ],
  "effective_stt_model": "<string>",
  "effective_stt_provider_data": {},
  "effective_tts_model": "<string>",
  "saved_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}