Update a library persona (Feather staff only)
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/library/personas/{persona_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": [
"<string>"
],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": false,
"policy": "live"
}
},
"tags": [
"<string>"
]
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}"
payload = {
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": ["<string>"],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": False,
"policy": "live"
}
},
"tags": ["<string>"]
}
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({
name: '<string>',
description: '<string>',
body: JSON.stringify('<string>'),
traits: {},
behavior_config: {
first_speaker: 'persona',
cut_in: {min_words: 10, min_duration_ms: 5000, backoff_ms: 1000},
language: '<string>',
background_noise: 'none',
background_noise_volume: 0.3,
wait_seconds: 0,
yield_on_overlap: {after_words: 2, after_seconds: 0.5},
interruption_mode: 'off',
backchannel_style: 'neutral',
backchannel_overrides: ['<string>'],
reaction_pause_ms_min: 200,
reaction_pause_ms_max: 500,
text_burst: {enabled: false, policy: 'live'}
},
tags: ['<string>']
})
};
fetch('https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}', 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/library/personas/{persona_id}",
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([
'name' => '<string>',
'description' => '<string>',
'body' => '<string>',
'traits' => [
],
'behavior_config' => [
'first_speaker' => 'persona',
'cut_in' => [
'min_words' => 10,
'min_duration_ms' => 5000,
'backoff_ms' => 1000
],
'language' => '<string>',
'background_noise' => 'none',
'background_noise_volume' => 0.3,
'wait_seconds' => 0,
'yield_on_overlap' => [
'after_words' => 2,
'after_seconds' => 0.5
],
'interruption_mode' => 'off',
'backchannel_style' => 'neutral',
'backchannel_overrides' => [
'<string>'
],
'reaction_pause_ms_min' => 200,
'reaction_pause_ms_max' => 500,
'text_burst' => [
'enabled' => false,
'policy' => 'live'
]
],
'tags' => [
'<string>'
]
]),
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/library/personas/{persona_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\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/library/personas/{persona_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": [
"<string>"
],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": false,
"policy": "live"
}
},
"tags": [
"<string>"
],
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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
Path Parameters
Body
Partial update of a library persona. Same null-rejection rules as
PersonaUpdate: explicit null is rejected for non-nullable columns.
Library entries are not org-scoped, so is_active is intentionally
not exposed — library content is either present in the catalog or
deleted from it.
1 - 2551Advanced simulation knobs attached to a persona. Stored as JSONB on
personas.behavior_config; per-run overrides will reuse this shape on
SimulationRun (ENG-474).
Show child attributes
Show child attributes
20Response
Successful Response
Library persona payload returned by /v1/library/personas routes.
Advanced simulation knobs attached to a persona. Stored as JSONB on
personas.behavior_config; per-run overrides will reuse this shape on
SimulationRun (ENG-474).
Show child attributes
Show child attributes
Was this page helpful?
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/library/personas/{persona_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": [
"<string>"
],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": false,
"policy": "live"
}
},
"tags": [
"<string>"
]
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}"
payload = {
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": ["<string>"],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": False,
"policy": "live"
}
},
"tags": ["<string>"]
}
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({
name: '<string>',
description: '<string>',
body: JSON.stringify('<string>'),
traits: {},
behavior_config: {
first_speaker: 'persona',
cut_in: {min_words: 10, min_duration_ms: 5000, backoff_ms: 1000},
language: '<string>',
background_noise: 'none',
background_noise_volume: 0.3,
wait_seconds: 0,
yield_on_overlap: {after_words: 2, after_seconds: 0.5},
interruption_mode: 'off',
backchannel_style: 'neutral',
backchannel_overrides: ['<string>'],
reaction_pause_ms_min: 200,
reaction_pause_ms_max: 500,
text_burst: {enabled: false, policy: 'live'}
},
tags: ['<string>']
})
};
fetch('https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}', 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/library/personas/{persona_id}",
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([
'name' => '<string>',
'description' => '<string>',
'body' => '<string>',
'traits' => [
],
'behavior_config' => [
'first_speaker' => 'persona',
'cut_in' => [
'min_words' => 10,
'min_duration_ms' => 5000,
'backoff_ms' => 1000
],
'language' => '<string>',
'background_noise' => 'none',
'background_noise_volume' => 0.3,
'wait_seconds' => 0,
'yield_on_overlap' => [
'after_words' => 2,
'after_seconds' => 0.5
],
'interruption_mode' => 'off',
'backchannel_style' => 'neutral',
'backchannel_overrides' => [
'<string>'
],
'reaction_pause_ms_min' => 200,
'reaction_pause_ms_max' => 500,
'text_burst' => [
'enabled' => false,
'policy' => 'live'
]
],
'tags' => [
'<string>'
]
]),
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/library/personas/{persona_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\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/library/personas/{persona_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"body\": \"<string>\",\n \"traits\": {},\n \"behavior_config\": {\n \"first_speaker\": \"persona\",\n \"cut_in\": {\n \"min_words\": 10,\n \"min_duration_ms\": 5000,\n \"backoff_ms\": 1000\n },\n \"language\": \"<string>\",\n \"background_noise\": \"none\",\n \"background_noise_volume\": 0.3,\n \"wait_seconds\": 0,\n \"yield_on_overlap\": {\n \"after_words\": 2,\n \"after_seconds\": 0.5\n },\n \"interruption_mode\": \"off\",\n \"backchannel_style\": \"neutral\",\n \"backchannel_overrides\": [\n \"<string>\"\n ],\n \"reaction_pause_ms_min\": 200,\n \"reaction_pause_ms_max\": 500,\n \"text_burst\": {\n \"enabled\": false,\n \"policy\": \"live\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"body": "<string>",
"traits": {},
"behavior_config": {
"first_speaker": "persona",
"cut_in": {
"min_words": 10,
"min_duration_ms": 5000,
"backoff_ms": 1000
},
"language": "<string>",
"background_noise": "none",
"background_noise_volume": 0.3,
"wait_seconds": 0,
"yield_on_overlap": {
"after_words": 2,
"after_seconds": 0.5
},
"interruption_mode": "off",
"backchannel_style": "neutral",
"backchannel_overrides": [
"<string>"
],
"reaction_pause_ms_min": 200,
"reaction_pause_ms_max": 500,
"text_burst": {
"enabled": false,
"policy": "live"
}
},
"tags": [
"<string>"
],
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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": {}
}
]
}