Install a library persona into the caller's workspace
POST
/
v1
/
library
/
personas
/
{persona_id}
/
install
Install a library persona into the caller's workspace
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name_override": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install"
payload = { "name_override": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name_override: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install', 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}/install",
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_override' => '<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}/install"
payload := strings.NewReader("{\n \"name_override\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name_override\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name_override\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"is_active": true,
"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"
}
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cloned_from_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
Path Parameters
Body
application/json
POST body for /v1/library/personas/{id}/install.
name_override lets callers pick a non-default name on install,
typically when re-installing a template that already has a copy in the
target org. When omitted, the service appends " (2)", " (3)",
etc. to deduplicate against existing org personas.
Required string length:
1 - 255Response
Successful Response
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?
⌘I
Install a library persona into the caller's workspace
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name_override": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install"
payload = { "name_override": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name_override: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install', 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}/install",
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_override' => '<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}/install"
payload := strings.NewReader("{\n \"name_override\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name_override\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/library/personas/{persona_id}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name_override\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"is_active": true,
"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"
}
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cloned_from_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": {}
}
]
}