Skip to main content
DELETE
Delete Digital Human
Integration Prompt for AI Agents
This endpoint allows you to delete a Digital Human. Provide the ID in the path to permanently delete a Digital Human.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

digital_human_id
integer
required

Response

Successful Response

Response model for digital human data.

intent
string
required

Description of the digital human

success_criteria
string
required

Success criteria for the digital human

id
integer | null

Unique identifier for the digital human

bluejay_as_code_id
string<uuid> | null

Stable code-addressable identifier

tag
string | null

Tag for categorizing the digital human

tags
string[] | null

All tags associated with the digital human

system_prompt_rule_ids
string[] | null

Ids of the system-prompt rules this digital human covers.

system_prompt_rule_quotes
string[] | null

The quoted system-prompt rules this digital human covers.

name
string | null

Name of the digital human

language
enum<string> | null

Language of the digital human

Available options:
en,
es,
pt,
ja,
tr,
hi,
ar,
he,
ru,
zh,
ml,
fr,
yue,
vi,
de,
ko,
ur,
te,
ta,
mal,
kn,
mr,
gu,
tl,
el,
ad
accent
enum<string> | null

Accent of the digital human

Available options:
multilingual,
american,
american2,
mature,
southern,
italian,
indian,
british,
australian,
scottish,
irish,
welsh,
mexican,
spanish,
portuguese,
french,
turkish,
japanese,
hindi,
arabic,
egyptian,
levantine,
hebrew,
russian,
chinese,
german,
korean,
urdu,
telugu,
tamil,
malayalam,
kannada,
marathi,
gujarati,
vietnamese,
cantonese,
tagalog,
greek,
autodetect,
watson,
watsonbritish,
watsonaustralian,
watsoncanadian
gender
enum<string> | null

Gender of the digital human

Available options:
male,
female
custom_voice_id
string | null

ElevenLabs voice_id of a cloned voice used for TTS, if assigned

background_noise
string | null

Type of background noise

custom_background_noise_url
string | null

Bucket-relative path of the uploaded custom background noise audio when background_noise is 'custom'

voice_speed
string | null

Speed of the digital human's voice

audio_quality
string | null

Audio quality of the digital human's voice

connection_quality
string | null

How often the caller's line drops out: none, low, medium or high

fluency
string | null

Fluency level of the digital human's speech

verbosity
string | null

Verbosity level of the digital human's responses

phone_number
string | null

Phone number for the digital human

extension
string | null

Extension dialed as DTMF after connecting when this DH calls an inbound agent

outbound_text_number
string | null

Outbound text number

follow_up_sms_success_criteria
string | null

Criteria the captured follow-up SMS is graded against

websocket_url
string | null

WebSocket URL for real-time communication

background_noise_volume
number | null

Volume of background noise

expected_tool_calls
ExpectedToolCall · object[] | null

Expected tool calls

allow_end_call_tool
boolean | null
default:true

Allow the digital human to end the tool call

allow_silence_tool
boolean | null
default:true

Allow the digital human to use the silence tool

allow_dtmf_tool
boolean | null
default:true

Allow the digital human to use the DTMF tool

default_dtmf_or_voiced
string | null
default:voiced
silence_tool_instructions
string | null
default:default

Tool instructions; "default" or custom text

endpointing_delay
number | null

Delay for endpointing

creativity
number | null

Temperature setting

hangup_phrases
string[] | null

Phrases that trigger hangup

hangup_instructions
string | null

Freeform instructions for how/when to hang up

silence_timeout
integer | null

Silence timeout in seconds

role_description
string | null

Description of the role for the digital human

created_at
string<date-time> | null

When this digital human was created

traits
Trait · object[] | null

List of traits associated with this digital human

interruptions
Interruptions · object | null

Interruption configuration for the digital human

scripted_responses
ScriptedResponse · object[] | null

List of scripted responses for the digital human, in the order they were saved

scripted_responses_ordered
boolean | null
default:false

When true, scripted_responses run as a script in list order (each fires once, next one arms); when false any one fires whenever its match_phrase comes up

speaks_first_config
SpeaksFirstConfig · object | null

Speaks first config: speaks_first, mode (custom|ai_generated), message (when custom), dynamic (wait for the agent, open only if quiet; defaults true)

original_transcript
string | null

The original transcript text attached to this digital human

formatted_transcript
Formatted Transcript · object[] | null

Structured transcript as [{"role": "USER"|"AGENT", "utterance": "..."}]

enriched_playback
Enriched Playback · object[] | null

Optional enriched playback stored as JSONB: a list of turn objects

workflow_v2_id
string<uuid> | null

Source workflow_v2 UUID — set when this DH is generated from a workflow

workflow_path_index
integer | null

0-based path index within enumerate_workflow_v2_paths output

tested_path
string[] | null

Ordered names of the workflow path steps this DH was generated from (Generate-From-Workflow only).

livekit_metadata
Livekit Metadata · object | null

LiveKit-specific configuration and metadata for this digital human

test_name
string | null

User-facing label for this digital human

journey_steps
JourneyStep · object[] | null

Ordered journey steps for a multi-step (Customer Journey) digital human

always_on_mode
boolean | null

Whether always-on mode is enabled

always_on_active
boolean | null
default:false

When true, this DH actively receives inbound calls on phone_number

num_runs
integer | null
default:1

Number of times this digital human is run per simulation run

attack_vector
string | null

Attack tactic key from VECTOR_CATALOG. NULL for non-red-team.

attack_type
string | null

Umbrella attack category. NULL for non-red-team.

attack_plan
Attack Plan · object | null

Crescendo escalation ladder. NULL for non-red-team.