v3

OpenAPI 3.1.02026-07-31350397683.8 KB

Digital Humans

Delete Digital Human

Delete a digital human by ID.

delete/v1/digital-human/{digital_human_id}

Path parameters

digital_human_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

idinteger nullable

Unique identifier for the digital human

bluejay_as_code_idstring uuid nullable

Stable code-addressable identifier

intentstring required

Description of the digital human

success_criteriastring required

Success criteria for the digital human

tagstring nullable

Tag for categorizing the digital human

tagsstring[] nullable

All tags associated with the digital human

namestring nullable

Name of the digital human

language'en' | 'es' | 'pt' | 'ja' | 'tr' | 'hi' | 'ar' | 'he' | 'ru' | 'zh' | 'ml' | 'fr' | 'yue' | 'vi' | 'de' | 'ko' | 'ur' | 'te' | 'ta' | 'mal' | 'kn' | 'mr' | 'gu' | 'ad'

Enum for supported language types.

Enum for accent options.

gender'male' | 'female'

Enum for gender options.

custom_voice_idstring nullable

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

background_noisestring nullable

Type of background noise

custom_background_noise_urlstring nullable

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

voice_speedstring nullable

Speed of the digital human's voice

audio_qualitystring nullable

Audio quality of the digital human's voice

fluencystring nullable

Fluency level of the digital human's speech

verbositystring nullable

Verbosity level of the digital human's responses

phone_numberstring nullable

Phone number for the digital human

extensionstring nullable

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

outbound_text_numberstring nullable

Outbound text number

follow_up_sms_success_criteriastring nullable

Criteria the captured follow-up SMS is graded against

websocket_urlstring nullable

WebSocket URL for real-time communication

background_noise_volumenumber nullable

Volume of background noise

allow_end_call_toolboolean nullable

Allow the digital human to end the tool call

allow_silence_toolboolean nullable

Allow the digital human to use the silence tool

allow_dtmf_toolboolean nullable

Allow the digital human to use the DTMF tool

default_dtmf_or_voicedstring nullable

silence_tool_instructionsstring nullable

Tool instructions; "default" or custom text

endpointing_delaynumber nullable

Delay for endpointing

creativitynumber nullable

Temperature setting

hangup_phrasesstring[] nullable

Phrases that trigger hangup

hangup_instructionsstring nullable

Freeform instructions for how/when to hang up

silence_timeoutinteger nullable

Silence timeout in seconds

role_descriptionstring nullable

Description of the role for the digital human

created_atstring date-time nullable

When this digital human was created

interruptionsobject nullable

Interruption configuration for the digital human

original_transcriptstring nullable

The original transcript text attached to this digital human

formatted_transcriptobject[] nullable

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

enriched_playbackobject[] nullable

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

workflow_v2_idstring uuid nullable

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

workflow_path_indexinteger nullable

0-based path index within enumerate_workflow_v2_paths output

tested_pathstring[] nullable

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

livekit_metadataobject nullable

LiveKit-specific configuration and metadata for this digital human

test_namestring nullable

User-facing label for this digital human