Create Digital Human
curl --request POST \
--url https://api.getbluejay.ai/v1/create-digital-human \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"digital_human": {
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "",
"success_criteria": "",
"name": "<string>",
"tag": "<string>",
"tags": [
"<string>"
],
"system_prompt_rule_ids": [
"<string>"
],
"system_prompt_rule_quotes": [
"<string>"
],
"language": "en",
"custom_voice_id": "<string>",
"background_noise": "none",
"custom_background_noise_url": "<string>",
"voice_speed": "normal",
"audio_quality": "high",
"connection_quality": "none",
"fluency": "native",
"verbosity": "medium",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"background_noise_volume": 0.8,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": true,
"allow_silence_tool": true,
"allow_dtmf_tool": true,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 1.5,
"creativity": 0.7,
"hangup_phrases": [
"<string>"
],
"hangup_instructions": "<string>",
"silence_timeout": 16,
"role_description": "<string>",
"traits": [
{
"trait_name": "<string>",
"value": "<unknown>",
"is_sip_header": false
}
],
"interruptions": {},
"scripted_responses": [
{
"match_phrase": "<string>",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": false,
"speaks_first_config": {
"speaks_first": true,
"message": "<string>",
"dynamic": true
},
"original_transcript": "<string>",
"formatted_transcript": [
{}
],
"enriched_playback": [
{}
],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 1,
"tested_path": [
"<string>"
],
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": false,
"phone_number": "<string>"
}
],
"always_on_mode": false,
"always_on_active": true,
"num_runs": 1,
"livekit_metadata": {},
"test_name": "<string>",
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [
123
],
"simulation_id": 123
}
'import requests
url = "https://api.getbluejay.ai/v1/create-digital-human"
payload = {
"digital_human": {
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "",
"success_criteria": "",
"name": "<string>",
"tag": "<string>",
"tags": ["<string>"],
"system_prompt_rule_ids": ["<string>"],
"system_prompt_rule_quotes": ["<string>"],
"language": "en",
"custom_voice_id": "<string>",
"background_noise": "none",
"custom_background_noise_url": "<string>",
"voice_speed": "normal",
"audio_quality": "high",
"connection_quality": "none",
"fluency": "native",
"verbosity": "medium",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"background_noise_volume": 0.8,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": True,
"allow_silence_tool": True,
"allow_dtmf_tool": True,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 1.5,
"creativity": 0.7,
"hangup_phrases": ["<string>"],
"hangup_instructions": "<string>",
"silence_timeout": 16,
"role_description": "<string>",
"traits": [
{
"trait_name": "<string>",
"value": "<unknown>",
"is_sip_header": False
}
],
"interruptions": {},
"scripted_responses": [
{
"match_phrase": "<string>",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": False,
"speaks_first_config": {
"speaks_first": True,
"message": "<string>",
"dynamic": True
},
"original_transcript": "<string>",
"formatted_transcript": [{}],
"enriched_playback": [{}],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 1,
"tested_path": ["<string>"],
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": False,
"phone_number": "<string>"
}
],
"always_on_mode": False,
"always_on_active": True,
"num_runs": 1,
"livekit_metadata": {},
"test_name": "<string>",
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [123],
"simulation_id": 123
}
headers = {
"X-API-Key": "<x-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': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
digital_human: {
bluejay_as_code_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
intent: '',
success_criteria: '',
name: '<string>',
tag: '<string>',
tags: ['<string>'],
system_prompt_rule_ids: ['<string>'],
system_prompt_rule_quotes: ['<string>'],
language: 'en',
custom_voice_id: '<string>',
background_noise: 'none',
custom_background_noise_url: '<string>',
voice_speed: 'normal',
audio_quality: 'high',
connection_quality: 'none',
fluency: 'native',
verbosity: 'medium',
phone_number: '<string>',
extension: '<string>',
outbound_text_number: '<string>',
follow_up_sms_success_criteria: '<string>',
background_noise_volume: 0.8,
expected_tool_calls: [{name: '<string>', parameters: {}, output: '<unknown>'}],
allow_end_call_tool: true,
allow_silence_tool: true,
allow_dtmf_tool: true,
default_dtmf_or_voiced: 'voiced',
silence_tool_instructions: 'default',
endpointing_delay: 1.5,
creativity: 0.7,
hangup_phrases: ['<string>'],
hangup_instructions: '<string>',
silence_timeout: 16,
role_description: '<string>',
traits: [{trait_name: '<string>', value: '<unknown>', is_sip_header: false}],
interruptions: {},
scripted_responses: [
{
match_phrase: '<string>',
response_value: '<string>',
scripted_response_audio_snippet_url: '<string>',
occurrence_n: 1,
silence_duration: 1
}
],
scripted_responses_ordered: false,
speaks_first_config: {speaks_first: true, message: '<string>', dynamic: true},
original_transcript: '<string>',
formatted_transcript: [{}],
enriched_playback: [{}],
workflow_v2_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workflow_path_index: 1,
tested_path: ['<string>'],
journey_steps: [
{
step: 1,
intent: '',
success_criteria: '',
modality: 'voice',
wait_seconds: 123,
response_window_seconds: 123,
unresponsive: false,
phone_number: '<string>'
}
],
always_on_mode: false,
always_on_active: true,
num_runs: 1,
livekit_metadata: {},
test_name: '<string>',
attack_vector: '<string>',
attack_type: '<string>',
attack_plan: {}
},
simulation_ids: [123],
simulation_id: 123
})
};
fetch('https://api.getbluejay.ai/v1/create-digital-human', 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.getbluejay.ai/v1/create-digital-human",
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([
'digital_human' => [
'bluejay_as_code_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'intent' => '',
'success_criteria' => '',
'name' => '<string>',
'tag' => '<string>',
'tags' => [
'<string>'
],
'system_prompt_rule_ids' => [
'<string>'
],
'system_prompt_rule_quotes' => [
'<string>'
],
'language' => 'en',
'custom_voice_id' => '<string>',
'background_noise' => 'none',
'custom_background_noise_url' => '<string>',
'voice_speed' => 'normal',
'audio_quality' => 'high',
'connection_quality' => 'none',
'fluency' => 'native',
'verbosity' => 'medium',
'phone_number' => '<string>',
'extension' => '<string>',
'outbound_text_number' => '<string>',
'follow_up_sms_success_criteria' => '<string>',
'background_noise_volume' => 0.8,
'expected_tool_calls' => [
[
'name' => '<string>',
'parameters' => [
],
'output' => '<unknown>'
]
],
'allow_end_call_tool' => true,
'allow_silence_tool' => true,
'allow_dtmf_tool' => true,
'default_dtmf_or_voiced' => 'voiced',
'silence_tool_instructions' => 'default',
'endpointing_delay' => 1.5,
'creativity' => 0.7,
'hangup_phrases' => [
'<string>'
],
'hangup_instructions' => '<string>',
'silence_timeout' => 16,
'role_description' => '<string>',
'traits' => [
[
'trait_name' => '<string>',
'value' => '<unknown>',
'is_sip_header' => false
]
],
'interruptions' => [
],
'scripted_responses' => [
[
'match_phrase' => '<string>',
'response_value' => '<string>',
'scripted_response_audio_snippet_url' => '<string>',
'occurrence_n' => 1,
'silence_duration' => 1
]
],
'scripted_responses_ordered' => false,
'speaks_first_config' => [
'speaks_first' => true,
'message' => '<string>',
'dynamic' => true
],
'original_transcript' => '<string>',
'formatted_transcript' => [
[
]
],
'enriched_playback' => [
[
]
],
'workflow_v2_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workflow_path_index' => 1,
'tested_path' => [
'<string>'
],
'journey_steps' => [
[
'step' => 1,
'intent' => '',
'success_criteria' => '',
'modality' => 'voice',
'wait_seconds' => 123,
'response_window_seconds' => 123,
'unresponsive' => false,
'phone_number' => '<string>'
]
],
'always_on_mode' => false,
'always_on_active' => true,
'num_runs' => 1,
'livekit_metadata' => [
],
'test_name' => '<string>',
'attack_vector' => '<string>',
'attack_type' => '<string>',
'attack_plan' => [
]
],
'simulation_ids' => [
123
],
'simulation_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-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.getbluejay.ai/v1/create-digital-human"
payload := strings.NewReader("{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-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.getbluejay.ai/v1/create-digital-human")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/create-digital-human")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"digital_human": {
"intent": "<string>",
"success_criteria": "<string>",
"id": 123,
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tag": "<string>",
"tags": [
"<string>"
],
"system_prompt_rule_ids": [
"<string>"
],
"system_prompt_rule_quotes": [
"<string>"
],
"name": "<string>",
"language": "en",
"accent": "multilingual",
"gender": "male",
"custom_voice_id": "<string>",
"background_noise": "<string>",
"custom_background_noise_url": "<string>",
"voice_speed": "<string>",
"audio_quality": "<string>",
"connection_quality": "<string>",
"fluency": "<string>",
"verbosity": "<string>",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"websocket_url": "<string>",
"background_noise_volume": 123,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": true,
"allow_silence_tool": true,
"allow_dtmf_tool": true,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 123,
"creativity": 123,
"hangup_phrases": [
"<string>"
],
"hangup_instructions": "<string>",
"silence_timeout": 123,
"role_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"traits": [
{
"trait_name": "<string>",
"trait_data_type": "BOOLEAN",
"value": "<unknown>",
"is_sip_header": false
}
],
"interruptions": {},
"scripted_responses": [
{
"match_type": "exact",
"match_phrase": "<string>",
"response_type": "phrase",
"occurrence_mode": "always",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": false,
"speaks_first_config": {
"speaks_first": true,
"mode": "custom",
"message": "<string>",
"dynamic": true
},
"original_transcript": "<string>",
"formatted_transcript": [
{}
],
"enriched_playback": [
{}
],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 123,
"tested_path": [
"<string>"
],
"livekit_metadata": {},
"test_name": "<string>",
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"direction": "inbound",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": false,
"phone_number": "<string>"
}
],
"always_on_mode": true,
"always_on_active": false,
"num_runs": 1,
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [
123
],
"simulation_id": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Digital Humans
Create Digital Human
Create a new Digital Human.
POST
/
v1
/
create-digital-human
Create Digital Human
curl --request POST \
--url https://api.getbluejay.ai/v1/create-digital-human \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"digital_human": {
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "",
"success_criteria": "",
"name": "<string>",
"tag": "<string>",
"tags": [
"<string>"
],
"system_prompt_rule_ids": [
"<string>"
],
"system_prompt_rule_quotes": [
"<string>"
],
"language": "en",
"custom_voice_id": "<string>",
"background_noise": "none",
"custom_background_noise_url": "<string>",
"voice_speed": "normal",
"audio_quality": "high",
"connection_quality": "none",
"fluency": "native",
"verbosity": "medium",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"background_noise_volume": 0.8,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": true,
"allow_silence_tool": true,
"allow_dtmf_tool": true,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 1.5,
"creativity": 0.7,
"hangup_phrases": [
"<string>"
],
"hangup_instructions": "<string>",
"silence_timeout": 16,
"role_description": "<string>",
"traits": [
{
"trait_name": "<string>",
"value": "<unknown>",
"is_sip_header": false
}
],
"interruptions": {},
"scripted_responses": [
{
"match_phrase": "<string>",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": false,
"speaks_first_config": {
"speaks_first": true,
"message": "<string>",
"dynamic": true
},
"original_transcript": "<string>",
"formatted_transcript": [
{}
],
"enriched_playback": [
{}
],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 1,
"tested_path": [
"<string>"
],
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": false,
"phone_number": "<string>"
}
],
"always_on_mode": false,
"always_on_active": true,
"num_runs": 1,
"livekit_metadata": {},
"test_name": "<string>",
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [
123
],
"simulation_id": 123
}
'import requests
url = "https://api.getbluejay.ai/v1/create-digital-human"
payload = {
"digital_human": {
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "",
"success_criteria": "",
"name": "<string>",
"tag": "<string>",
"tags": ["<string>"],
"system_prompt_rule_ids": ["<string>"],
"system_prompt_rule_quotes": ["<string>"],
"language": "en",
"custom_voice_id": "<string>",
"background_noise": "none",
"custom_background_noise_url": "<string>",
"voice_speed": "normal",
"audio_quality": "high",
"connection_quality": "none",
"fluency": "native",
"verbosity": "medium",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"background_noise_volume": 0.8,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": True,
"allow_silence_tool": True,
"allow_dtmf_tool": True,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 1.5,
"creativity": 0.7,
"hangup_phrases": ["<string>"],
"hangup_instructions": "<string>",
"silence_timeout": 16,
"role_description": "<string>",
"traits": [
{
"trait_name": "<string>",
"value": "<unknown>",
"is_sip_header": False
}
],
"interruptions": {},
"scripted_responses": [
{
"match_phrase": "<string>",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": False,
"speaks_first_config": {
"speaks_first": True,
"message": "<string>",
"dynamic": True
},
"original_transcript": "<string>",
"formatted_transcript": [{}],
"enriched_playback": [{}],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 1,
"tested_path": ["<string>"],
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": False,
"phone_number": "<string>"
}
],
"always_on_mode": False,
"always_on_active": True,
"num_runs": 1,
"livekit_metadata": {},
"test_name": "<string>",
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [123],
"simulation_id": 123
}
headers = {
"X-API-Key": "<x-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': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
digital_human: {
bluejay_as_code_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
intent: '',
success_criteria: '',
name: '<string>',
tag: '<string>',
tags: ['<string>'],
system_prompt_rule_ids: ['<string>'],
system_prompt_rule_quotes: ['<string>'],
language: 'en',
custom_voice_id: '<string>',
background_noise: 'none',
custom_background_noise_url: '<string>',
voice_speed: 'normal',
audio_quality: 'high',
connection_quality: 'none',
fluency: 'native',
verbosity: 'medium',
phone_number: '<string>',
extension: '<string>',
outbound_text_number: '<string>',
follow_up_sms_success_criteria: '<string>',
background_noise_volume: 0.8,
expected_tool_calls: [{name: '<string>', parameters: {}, output: '<unknown>'}],
allow_end_call_tool: true,
allow_silence_tool: true,
allow_dtmf_tool: true,
default_dtmf_or_voiced: 'voiced',
silence_tool_instructions: 'default',
endpointing_delay: 1.5,
creativity: 0.7,
hangup_phrases: ['<string>'],
hangup_instructions: '<string>',
silence_timeout: 16,
role_description: '<string>',
traits: [{trait_name: '<string>', value: '<unknown>', is_sip_header: false}],
interruptions: {},
scripted_responses: [
{
match_phrase: '<string>',
response_value: '<string>',
scripted_response_audio_snippet_url: '<string>',
occurrence_n: 1,
silence_duration: 1
}
],
scripted_responses_ordered: false,
speaks_first_config: {speaks_first: true, message: '<string>', dynamic: true},
original_transcript: '<string>',
formatted_transcript: [{}],
enriched_playback: [{}],
workflow_v2_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workflow_path_index: 1,
tested_path: ['<string>'],
journey_steps: [
{
step: 1,
intent: '',
success_criteria: '',
modality: 'voice',
wait_seconds: 123,
response_window_seconds: 123,
unresponsive: false,
phone_number: '<string>'
}
],
always_on_mode: false,
always_on_active: true,
num_runs: 1,
livekit_metadata: {},
test_name: '<string>',
attack_vector: '<string>',
attack_type: '<string>',
attack_plan: {}
},
simulation_ids: [123],
simulation_id: 123
})
};
fetch('https://api.getbluejay.ai/v1/create-digital-human', 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.getbluejay.ai/v1/create-digital-human",
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([
'digital_human' => [
'bluejay_as_code_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'intent' => '',
'success_criteria' => '',
'name' => '<string>',
'tag' => '<string>',
'tags' => [
'<string>'
],
'system_prompt_rule_ids' => [
'<string>'
],
'system_prompt_rule_quotes' => [
'<string>'
],
'language' => 'en',
'custom_voice_id' => '<string>',
'background_noise' => 'none',
'custom_background_noise_url' => '<string>',
'voice_speed' => 'normal',
'audio_quality' => 'high',
'connection_quality' => 'none',
'fluency' => 'native',
'verbosity' => 'medium',
'phone_number' => '<string>',
'extension' => '<string>',
'outbound_text_number' => '<string>',
'follow_up_sms_success_criteria' => '<string>',
'background_noise_volume' => 0.8,
'expected_tool_calls' => [
[
'name' => '<string>',
'parameters' => [
],
'output' => '<unknown>'
]
],
'allow_end_call_tool' => true,
'allow_silence_tool' => true,
'allow_dtmf_tool' => true,
'default_dtmf_or_voiced' => 'voiced',
'silence_tool_instructions' => 'default',
'endpointing_delay' => 1.5,
'creativity' => 0.7,
'hangup_phrases' => [
'<string>'
],
'hangup_instructions' => '<string>',
'silence_timeout' => 16,
'role_description' => '<string>',
'traits' => [
[
'trait_name' => '<string>',
'value' => '<unknown>',
'is_sip_header' => false
]
],
'interruptions' => [
],
'scripted_responses' => [
[
'match_phrase' => '<string>',
'response_value' => '<string>',
'scripted_response_audio_snippet_url' => '<string>',
'occurrence_n' => 1,
'silence_duration' => 1
]
],
'scripted_responses_ordered' => false,
'speaks_first_config' => [
'speaks_first' => true,
'message' => '<string>',
'dynamic' => true
],
'original_transcript' => '<string>',
'formatted_transcript' => [
[
]
],
'enriched_playback' => [
[
]
],
'workflow_v2_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workflow_path_index' => 1,
'tested_path' => [
'<string>'
],
'journey_steps' => [
[
'step' => 1,
'intent' => '',
'success_criteria' => '',
'modality' => 'voice',
'wait_seconds' => 123,
'response_window_seconds' => 123,
'unresponsive' => false,
'phone_number' => '<string>'
]
],
'always_on_mode' => false,
'always_on_active' => true,
'num_runs' => 1,
'livekit_metadata' => [
],
'test_name' => '<string>',
'attack_vector' => '<string>',
'attack_type' => '<string>',
'attack_plan' => [
]
],
'simulation_ids' => [
123
],
'simulation_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-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.getbluejay.ai/v1/create-digital-human"
payload := strings.NewReader("{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-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.getbluejay.ai/v1/create-digital-human")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/create-digital-human")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"digital_human\": {\n \"bluejay_as_code_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"name\": \"<string>\",\n \"tag\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"system_prompt_rule_ids\": [\n \"<string>\"\n ],\n \"system_prompt_rule_quotes\": [\n \"<string>\"\n ],\n \"language\": \"en\",\n \"custom_voice_id\": \"<string>\",\n \"background_noise\": \"none\",\n \"custom_background_noise_url\": \"<string>\",\n \"voice_speed\": \"normal\",\n \"audio_quality\": \"high\",\n \"connection_quality\": \"none\",\n \"fluency\": \"native\",\n \"verbosity\": \"medium\",\n \"phone_number\": \"<string>\",\n \"extension\": \"<string>\",\n \"outbound_text_number\": \"<string>\",\n \"follow_up_sms_success_criteria\": \"<string>\",\n \"background_noise_volume\": 0.8,\n \"expected_tool_calls\": [\n {\n \"name\": \"<string>\",\n \"parameters\": {},\n \"output\": \"<unknown>\"\n }\n ],\n \"allow_end_call_tool\": true,\n \"allow_silence_tool\": true,\n \"allow_dtmf_tool\": true,\n \"default_dtmf_or_voiced\": \"voiced\",\n \"silence_tool_instructions\": \"default\",\n \"endpointing_delay\": 1.5,\n \"creativity\": 0.7,\n \"hangup_phrases\": [\n \"<string>\"\n ],\n \"hangup_instructions\": \"<string>\",\n \"silence_timeout\": 16,\n \"role_description\": \"<string>\",\n \"traits\": [\n {\n \"trait_name\": \"<string>\",\n \"value\": \"<unknown>\",\n \"is_sip_header\": false\n }\n ],\n \"interruptions\": {},\n \"scripted_responses\": [\n {\n \"match_phrase\": \"<string>\",\n \"response_value\": \"<string>\",\n \"scripted_response_audio_snippet_url\": \"<string>\",\n \"occurrence_n\": 1,\n \"silence_duration\": 1\n }\n ],\n \"scripted_responses_ordered\": false,\n \"speaks_first_config\": {\n \"speaks_first\": true,\n \"message\": \"<string>\",\n \"dynamic\": true\n },\n \"original_transcript\": \"<string>\",\n \"formatted_transcript\": [\n {}\n ],\n \"enriched_playback\": [\n {}\n ],\n \"workflow_v2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workflow_path_index\": 1,\n \"tested_path\": [\n \"<string>\"\n ],\n \"journey_steps\": [\n {\n \"step\": 1,\n \"intent\": \"\",\n \"success_criteria\": \"\",\n \"modality\": \"voice\",\n \"wait_seconds\": 123,\n \"response_window_seconds\": 123,\n \"unresponsive\": false,\n \"phone_number\": \"<string>\"\n }\n ],\n \"always_on_mode\": false,\n \"always_on_active\": true,\n \"num_runs\": 1,\n \"livekit_metadata\": {},\n \"test_name\": \"<string>\",\n \"attack_vector\": \"<string>\",\n \"attack_type\": \"<string>\",\n \"attack_plan\": {}\n },\n \"simulation_ids\": [\n 123\n ],\n \"simulation_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"digital_human": {
"intent": "<string>",
"success_criteria": "<string>",
"id": 123,
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tag": "<string>",
"tags": [
"<string>"
],
"system_prompt_rule_ids": [
"<string>"
],
"system_prompt_rule_quotes": [
"<string>"
],
"name": "<string>",
"language": "en",
"accent": "multilingual",
"gender": "male",
"custom_voice_id": "<string>",
"background_noise": "<string>",
"custom_background_noise_url": "<string>",
"voice_speed": "<string>",
"audio_quality": "<string>",
"connection_quality": "<string>",
"fluency": "<string>",
"verbosity": "<string>",
"phone_number": "<string>",
"extension": "<string>",
"outbound_text_number": "<string>",
"follow_up_sms_success_criteria": "<string>",
"websocket_url": "<string>",
"background_noise_volume": 123,
"expected_tool_calls": [
{
"name": "<string>",
"parameters": {},
"output": "<unknown>"
}
],
"allow_end_call_tool": true,
"allow_silence_tool": true,
"allow_dtmf_tool": true,
"default_dtmf_or_voiced": "voiced",
"silence_tool_instructions": "default",
"endpointing_delay": 123,
"creativity": 123,
"hangup_phrases": [
"<string>"
],
"hangup_instructions": "<string>",
"silence_timeout": 123,
"role_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"traits": [
{
"trait_name": "<string>",
"trait_data_type": "BOOLEAN",
"value": "<unknown>",
"is_sip_header": false
}
],
"interruptions": {},
"scripted_responses": [
{
"match_type": "exact",
"match_phrase": "<string>",
"response_type": "phrase",
"occurrence_mode": "always",
"response_value": "<string>",
"scripted_response_audio_snippet_url": "<string>",
"occurrence_n": 1,
"silence_duration": 1
}
],
"scripted_responses_ordered": false,
"speaks_first_config": {
"speaks_first": true,
"mode": "custom",
"message": "<string>",
"dynamic": true
},
"original_transcript": "<string>",
"formatted_transcript": [
{}
],
"enriched_playback": [
{}
],
"workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_path_index": 123,
"tested_path": [
"<string>"
],
"livekit_metadata": {},
"test_name": "<string>",
"journey_steps": [
{
"step": 1,
"intent": "",
"success_criteria": "",
"modality": "voice",
"direction": "inbound",
"wait_seconds": 123,
"response_window_seconds": 123,
"unresponsive": false,
"phone_number": "<string>"
}
],
"always_on_mode": true,
"always_on_active": false,
"num_runs": 1,
"attack_vector": "<string>",
"attack_type": "<string>",
"attack_plan": {}
},
"simulation_ids": [
123
],
"simulation_id": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Integration Prompt for AI Agents
# Bluejay — Testing & Monitoring Platform for Conversational AI Agents
You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.
## Create Digital Human — POST /v1/create-digital-human
> **What this endpoint does:** Create a new Digital Human.
**Endpoint:** POST `https://api.getbluejay.ai/v1/create-digital-human`
**Auth:** `X-API-Key` header
**Content-Type:** application/json
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| digital_human | object | Digital Human data model for requests (without id and created_at). intent and success_criteria default to empty strings. `allow_silence_tool` defaults to false; `silence_tool_instructions` defaults to `"default"` (built-in silence-tool behavior). |
Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/create-digital-human and include any optional parameters (e.g., `simulation_ids`, `simulation_id`) that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.
### Request Body (required fields)
```json
{
"digital_human": {
"intent": "",
"success_criteria": "",
"name": "string",
"tag": "string",
"language": "en",
"accent": "multilingual",
"gender": "male",
"background_noise": "none",
"voice_speed": "slowest",
"audio_quality": "high",
"fluency": "beginner",
"verbosity": "low",
"phone_number": "+15551234567",
"outbound_text_number": "string",
"background_noise_volume": 1.0,
"expected_tool_calls": [
{
"name": "example_name",
"parameters": {
"key": "value"
}
}
],
"allow_end_call_tool": true,
"endpointing_delay": 1.0,
"creativity": 1.0,
"hangup_phrases": [
"string"
],
"hangup_instructions": "string",
"allow_silence_tool": false,
"silence_tool_instructions": "default",
"silence_timeout": 123,
"role_description": "string",
"traits": [
{
"trait_name": "example_name",
"trait_data_type": "BOOLEAN",
"value": "string",
"is_sip_header": false
}
],
"interruptions": {
"type": "none"
},
"scripted_responses": [
{
"match_type": "exact",
"match_phrase": "string",
"response_type": "phrase",
"response_value": "string",
"occurrence_mode": "always",
"occurrence_n": 123,
"silence_duration": 123
}
],
"speaks_first_config": {
"speaks_first": true,
"mode": "custom",
"message": "string"
},
"original_transcript": "string",
"formatted_transcript": [
{
"key": "value"
}
],
"enriched_playback": [
{
"key": "value"
}
],
"always_on_mode": true,
"always_on_active": true,
"num_runs": 123,
"livekit_metadata": {
"key": "value"
}
}
}
```
> **Note:** `endpointing_delay` is referenced as **patience** in the UI. It controls how long (in seconds) the Digital Human waits after silence before assuming the speaker has finished talking. On an SMS Digital Human it is the minimum wait (in seconds) before a reply is sent, counting the time spent composing it. Requests may send it as `patience` instead; `endpointing_delay` is kept for existing integrations and wins if both are given.
Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/create-digital-human. Include optional fields that serve the goal of setting up for testing and monitoring on Bluejay.
### Example
**POST with body:**
```python
import requests
def create_digital_human(payload: dict, api_key: str) -> dict:
url = "https://api.getbluejay.ai/v1/create-digital-human"
headers = {"X-API-Key": api_key}
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
return response.json()
```
### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 400: Workflow-tagged or business-rule violation (e.g. always-on mode mismatch, invalid phone number, missing SIP prerequisites); 409: Phone number conflict: another always-on active Digital Human already uses this phone number; 422: Validation Error.
### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?
Then implement the integration, export it, and confirm it compiles/passes lint.
Body
application/json
Request model for creating a digital human.
Response
Successful Response
Response model for digital human operations with clear separation of digital human data and simulation context.