"use strict";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const apiOperations=[{"group":`Simulations`,"slug":`api-reference/endpoint/create-simulation`,"method":`POST`,"path":`/v1/create-simulation`,"summary":`Create Simulation`,"params":[],"body":`{ "agent_id": "", "name": "", "description": "", "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "max_concurrent": 123, "hangup_on_transfer": false, "max_call_duration": 10, "max_call_duration_units": "minutes", "ringing_timeout": 300, "digital_humans_settings": { "default_name": "random", "default_caller_number": "random", "default_language": "random", "default_background_noise": "none", "first_message": "ai_generated", "num_runs": 1 }, "selected_custom_metrics": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "custom_metrics_failing_threshold": 123, "custom_metrics_passing_threshold": 123, "runs_per_digital_human": 123, "delay_between_tests_seconds": 1.5, "inactivity_timeout_seconds": 123, "always_on": false }`,"bodyType":`application/json`},{"group":`Simulations`,"slug":`api-reference/endpoint/add-digital-humans-to-simulation`,"method":`POST`,"path":`/v1/simulation/{simulation_id}/add-digital-humans`,"summary":`Add Digital Humans To Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":`{ "digital_human_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Simulations`,"slug":`api-reference/endpoint/remove-digital-humans-from-simulation`,"method":`POST`,"path":`/v1/simulation/{simulation_id}/remove-digital-humans`,"summary":`Remove Digital Humans From Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":`{ "digital_human_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Simulations`,"slug":`api-reference/endpoint/update-simulation`,"method":`PUT`,"path":`/v1/simulation/{simulation_id}`,"summary":`Update Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":`{ "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "", "description": "", "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "max_concurrent": 123, "hangup_on_transfer": true, "max_call_duration": 123, "max_call_duration_units": "minutes", "max_turns": 123, "ringing_timeout": 123, "digital_humans_settings": {}, "selected_custom_metrics": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "custom_metrics_failing_threshold": 123, "custom_metrics_passing_threshold": 123, "outcome_failing_threshold": 123, "outcome_passing_threshold": 123, "runs_per_digital_human": 123, "delay_between_tests_seconds": 1.5, "inactivity_timeout_seconds": 123, "tags": [ "" ], "pinned": true, "custom_error_enabled": true, "custom_error_prompt": "", "enable_rerun_failed_test_results": true, "enable_rerun_on_custom_error": true, "rerun_max_retries": 123 }`,"bodyType":`application/json`},{"group":`Simulations`,"slug":`api-reference/endpoint/get-simulation`,"method":`GET`,"path":`/v1/simulation/{simulation_id}`,"summary":`Get Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Simulations`,"slug":`api-reference/endpoint/get-all-simulations`,"method":`GET`,"path":`/v1/get-all-simulations`,"summary":`Get All Simulations`,"params":[],"body":null,"bodyType":null},{"group":`Simulations`,"slug":`api-reference/endpoint/get-simulations-by-agent`,"method":`GET`,"path":`/v1/get-simulations-by-agent/{agent_id}`,"summary":`Get Simulations By Agent`,"params":[{"name":`agent_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Simulations`,"slug":`api-reference/endpoint/delete-simulation`,"method":`DELETE`,"path":`/v1/simulation/{simulation_id}`,"summary":`Delete Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Simulations`,"slug":`api-reference/endpoint/queue-http-text-simulation-run`,"method":`POST`,"path":`/v1/queue-http-text-simulation-run`,"summary":`Queue Http Simulation Run`,"params":[],"body":`{ "simulation_id": "", "prompt_id": "", "agent_version_id": "", "knowledge_base_id": "", "digital_human_ids": [ "" ], "runs_per_digital_human": 123 }`,"bodyType":`application/json`},{"group":`Simulations`,"slug":`api-reference/endpoint/send-http-text-message`,"method":`POST`,"path":`/v1/send-http-text-message`,"summary":`Send Http Text Message`,"params":[],"body":`{ "simulation_result_id": "", "end_conversation": false, "end_turn": true, "message_id": "", "type": "message", "message": "" }`,"bodyType":`application/json`},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/queue-simulation-run`,"method":`POST`,"path":`/v1/queue-simulation-run`,"summary":`Queue Simulation Run Endpoint`,"params":[],"body":`{ "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "digital_human_ids": [ "" ], "phone_number": "", "sip_uri": "", "livekit_agent_name": "", "livekit_metadata": {}, "pipecat_agent_name": "", "pipecat_agent_configuration": {}, "pipecat_room_properties": {}, "eleven_labs_agent_id": "", "retell_agent_id": "", "vapi_assistant_id": "", "runs_per_digital_human": 123 }`,"bodyType":`application/json`},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/queue-sms-simulation-run`,"method":`POST`,"path":`/v1/queue-sms-simulation-run`,"summary":`Queue Sms Simulation Run`,"params":[],"body":`{ "simulation_id": "", "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "digital_human_ids": [ "" ], "terminate_overlapping_simulations": false, "runs_per_digital_human": 123 }`,"bodyType":`application/json`},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/get-simulation-runs`,"method":`GET`,"path":`/v1/get-simulation-runs/{simulation_id}`,"summary":`Get Simulation Runs`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/update-simulation-result`,"method":`POST`,"path":`/v1/update-simulation-result`,"summary":`Update Simulation Result`,"params":[],"body":`{ "simulation_result_id": "", "start_time": "2026-01-01T00:00:00Z", "end_time": "2026-01-01T00:00:00Z", "duration": 123, "events": [ { "title": "", "start_offset_ms": 123, "description": "", "end_offset_ms": 123, "tags": [ "" ], "metadata": {} } ], "tool_calls": [ { "name": "", "start_offset_ms": 123, "description": "", "parameters": {}, "output": null } ], "recorded_transcript": [ { "start_offset_ms": 123, "end_offset_ms": 123, "speaker": "AGENT", "utterance": "", "filler_utterance": true } ], "tags": [ "" ], "metadata": {}, "trace_ids": [ "" ] }`,"bodyType":`application/json`},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/retrieve-simulation-results`,"method":`GET`,"path":`/v1/retrieve-simulation-results/{simulation_run_id}`,"summary":`Retrieve Simulation Results`,"params":[{"name":`simulation_run_id`,"in":`path`,"required":true},{"name":`limit`,"in":`query`,"required":false},{"name":`offset`,"in":`query`,"required":false},{"name":`issue_ids`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/retrieve-simulation-result`,"method":`GET`,"path":`/v1/retrieve-simulation-result/{test_result_id}`,"summary":`Retrieve Simulation Result`,"params":[{"name":`test_result_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Simulation Runs`,"slug":`api-reference/endpoint/end-conversations`,"method":`POST`,"path":`/v1/end-conversations`,"summary":`End Conversations`,"params":[],"body":`{ "test_result_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/create-digital-human`,"method":`POST`,"path":`/v1/create-digital-human`,"summary":`Create Digital Human`,"params":[],"body":`{ "simulation_ids": [ 123 ], "simulation_id": 123, "digital_human": { "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "intent": "", "success_criteria": "", "name": "", "tag": "", "tags": [ "" ], "type": "voicemail_custom", "system_prompt_rule_ids": [ "" ], "system_prompt_rule_quotes": [ "" ], "language": "en", "accent": "multilingual", "gender": "male", "custom_voice_id": "", "background_noise": "none", "custom_background_noise_url": "", "voice_speed": "slowest", "audio_quality": "high", "fluency": "beginner", "verbosity": "low", "phone_number": "", "extension": "", "outbound_text_number": "", "follow_up_sms_success_criteria": "", "background_noise_volume": 0.8, "expected_tool_calls": [ { "name": "", "parameters": {}, "output": null } ], "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": [ "" ], "hangup_instructions": "", "silence_timeout": 123, "role_description": "", "traits": [ { "trait_name": "", "trait_data_type": "BOOLEAN", "value": null, "is_sip_header": false } ], "interruptions": { "type": "none" }, "scripted_responses": [ { "match_type": "exact", "match_phrase": "", "response_type": "phrase", "response_value": "", "scripted_response_audio_snippet_url": "", "occurrence_mode": "always", "occurrence_n": 123, "silence_duration": 123 } ], "scripted_responses_ordered": false, "speaks_first_config": { "speaks_first": true, "mode": "custom", "message": "", "dynamic": true }, "original_transcript": "", "formatted_transcript": [ { "key": "" } ], "enriched_playback": [ {} ], "workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "workflow_path_index": 123, "tested_path": [ "" ], "journey_steps": [ { "step": 123, "intent": "", "success_criteria": "", "modality": "voice", "direction": "inbound", "wait_seconds": 123, "response_window_seconds": 123, "unresponsive": false, "phone_number": "" } ], "always_on_mode": false, "always_on_active": true, "num_runs": 1, "livekit_metadata": {}, "test_name": "", "attack_vector": "", "attack_type": "", "attack_plan": {} } }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/create-digital-humans`,"method":`POST`,"path":`/v1/create-digital-humans`,"summary":`Bulk Create Digital Humans`,"params":[],"body":`{ "simulation_ids": [ 123 ], "digital_humans": [ { "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "intent": "", "success_criteria": "", "name": "", "tag": "", "tags": [ "" ], "type": "voicemail_custom", "system_prompt_rule_ids": [ "" ], "system_prompt_rule_quotes": [ "" ], "language": "en", "accent": "multilingual", "gender": "male", "custom_voice_id": "", "background_noise": "none", "custom_background_noise_url": "", "voice_speed": "slowest", "audio_quality": "high", "fluency": "beginner", "verbosity": "low", "phone_number": "", "extension": "", "outbound_text_number": "", "follow_up_sms_success_criteria": "", "background_noise_volume": 0.8, "expected_tool_calls": [ { "name": "", "parameters": {}, "output": null } ], "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": [ "" ], "hangup_instructions": "", "silence_timeout": 123, "role_description": "", "traits": [ { "trait_name": "", "trait_data_type": "BOOLEAN", "value": null, "is_sip_header": false } ], "interruptions": { "type": "none" }, "scripted_responses": [ { "match_type": "exact", "match_phrase": "", "response_type": "phrase", "response_value": "", "scripted_response_audio_snippet_url": "", "occurrence_mode": "always", "occurrence_n": 123, "silence_duration": 123 } ], "scripted_responses_ordered": false, "speaks_first_config": { "speaks_first": true, "mode": "custom", "message": "", "dynamic": true }, "original_transcript": "", "formatted_transcript": [ { "key": "" } ], "enriched_playback": [ {} ], "workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "workflow_path_index": 123, "tested_path": [ "" ], "journey_steps": [ { "step": 123, "intent": "", "success_criteria": "", "modality": "voice", "direction": "inbound", "wait_seconds": 123, "response_window_seconds": 123, "unresponsive": false, "phone_number": "" } ], "always_on_mode": false, "always_on_active": true, "num_runs": 1, "livekit_metadata": {}, "test_name": "", "attack_vector": "", "attack_type": "", "attack_plan": {} } ] }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/generate-digital-humans`,"method":`POST`,"path":`/v1/generate-digital-humans`,"summary":`Generate Digital Humans`,"params":[],"body":`{ "agent_id": "", "simulation_id": "", "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "goal_adherence": [ { "goal": "", "num_calls": 123 } ], "workflow_adherence": { "key": 123 }, "workflow_adherence_v2": { "key": 123 }, "replay_transcript": [ { "transcript": "", "success_criteria": "", "mode": "strict" } ], "customer_personas": [ { "name": "", "description": "", "goal": "", "num_calls": 123 } ], "system_prompt": 0, "load_testing": 0, "red_teaming": 0, "red_team_attacks": { "batches": [ { "intent": "", "vector_id": "", "traits": [ { "name": null, "data_type": "string", "value": null, "completeness": null } ], "count": 123, "custom_success_criteria": "" } ] }, "traits": [ { "trait_name": "", "trait_data_type": "BOOLEAN", "value": null, "is_sip_header": false } ], "num_runs": 1 }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/update-digital-human`,"method":`PUT`,"path":`/v1/update-digital-human/{digital_human_id}`,"summary":`Update Digital Human`,"params":[{"name":`digital_human_id`,"in":`path`,"required":true}],"body":`{ "intent": "", "success_criteria": "", "name": "", "tag": "", "tags": [ "" ], "type": "voicemail_custom", "language": "en", "accent": "multilingual", "gender": "male", "custom_voice_id": "", "background_noise": "none", "custom_background_noise_url": "", "voice_speed": "slowest", "audio_quality": "high", "fluency": "beginner", "verbosity": "low", "phone_number": "", "extension": "", "outbound_text_number": "", "follow_up_sms_success_criteria": "", "background_noise_volume": 1.5, "expected_tool_calls": [ { "name": "", "parameters": {}, "output": null } ], "allow_end_call_tool": true, "allow_silence_tool": true, "allow_dtmf_tool": true, "default_dtmf_or_voiced": "voiced", "silence_tool_instructions": "", "endpointing_delay": 1.5, "creativity": 1.5, "hangup_phrases": [ "" ], "hangup_instructions": "", "silence_timeout": 123, "simulation_ids": [ 123 ], "traits": [ { "trait_name": "", "trait_data_type": "BOOLEAN", "value": null, "is_sip_header": false } ], "traits_mode": "replace", "interruptions": { "type": "none" }, "scripted_responses": [ { "match_type": "exact", "match_phrase": "", "response_type": "phrase", "response_value": "", "scripted_response_audio_snippet_url": "", "occurrence_mode": "always", "occurrence_n": 123, "silence_duration": 123 } ], "scripted_responses_ordered": true, "role_description": "", "speaks_first_config": { "speaks_first": true, "mode": "custom", "message": "", "dynamic": true }, "original_transcript": "", "formatted_transcript": [ { "key": "" } ], "enriched_playback": [ {} ], "num_runs": 123, "livekit_metadata": {}, "always_on_mode": true, "always_on_active": true, "test_name": "", "journey_steps": [ { "step": 123, "intent": "", "success_criteria": "", "modality": "voice", "direction": "inbound", "wait_seconds": 123, "response_window_seconds": 123, "unresponsive": false, "phone_number": "" } ], "override_conflict": false, "system_prompt_rule_ids": [ "" ], "system_prompt_rule_quotes": [ "" ], "workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "workflow_path_index": 123, "tested_path": [ "" ], "attack_vector": "", "attack_type": "", "attack_plan": {} }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/get-digital-human`,"method":`GET`,"path":`/v1/digital-human/{digital_human_id}`,"summary":`Get Digital Human`,"params":[{"name":`digital_human_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Digital Humans`,"slug":`api-reference/endpoint/get-digital-humans-by-simulation`,"method":`GET`,"path":`/v1/digital-humans-by-simulation/{simulation_id}`,"summary":`Get Digital Humans By Simulation`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Digital Humans`,"slug":`api-reference/endpoint/get-all-digital-humans`,"method":`GET`,"path":`/v1/digital-humans`,"summary":`Get All Digital Humans`,"params":[{"name":`page_size`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false},{"name":`type`,"in":`query`,"required":false},{"name":`tag`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Digital Humans`,"slug":`api-reference/endpoint/delete-digital-human`,"method":`DELETE`,"path":`/v1/digital-human/{digital_human_id}`,"summary":`Delete Digital Human`,"params":[{"name":`digital_human_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Digital Humans`,"slug":`api-reference/endpoint/generate-objectives`,"method":`POST`,"path":`/v1/generate-objectives`,"summary":`Generate Objectives Endpoint`,"params":[],"body":`{ "test_case_id": 123 }`,"bodyType":`application/json`},{"group":`Digital Humans`,"slug":`api-reference/endpoint/generate-intent-summary`,"method":`POST`,"path":`/v1/generate-intent-summary`,"summary":`Generate Intent Summary Endpoint`,"params":[],"body":`{ "test_case_id": 123 }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/list-personalities`,"method":`GET`,"path":`/v1/personalities`,"summary":`List Personalities`,"params":[],"body":null,"bodyType":null},{"group":`Personalities`,"slug":`api-reference/endpoint/create-personalities`,"method":`POST`,"path":`/v1/personalities`,"summary":`Create Personalities`,"params":[],"body":`{ "personalities": [ { "language": "", "accent": "", "gender": "", "background_noise": "none", "background_noise_volume": 1.5, "custom_background_noise_url": "", "voice_speed": "slowest", "audio_quality": "horrible", "fluency": "beginner", "verbosity": "low", "endpointing_delay": 1.5, "silence_timeout": 123, "temperature": 1.5, "interruption_configs": {}, "role_description": "", "name": "" } ] }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/update-personality`,"method":`PATCH`,"path":`/v1/personalities/{personality_id}`,"summary":`Update Personality`,"params":[{"name":`personality_id`,"in":`path`,"required":true}],"body":`{ "language": "", "accent": "", "gender": "", "background_noise": "none", "background_noise_volume": 1.5, "custom_background_noise_url": "", "voice_speed": "slowest", "audio_quality": "horrible", "fluency": "beginner", "verbosity": "low", "endpointing_delay": 1.5, "silence_timeout": 123, "temperature": 1.5, "interruption_configs": {}, "role_description": "", "name": "" }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/delete-personality`,"method":`DELETE`,"path":`/v1/personalities/{personality_id}`,"summary":`Delete Personality`,"params":[{"name":`personality_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Personalities`,"slug":`api-reference/endpoint/get-simulation-personalities`,"method":`GET`,"path":`/v1/simulations/{simulation_id}/personalities`,"summary":`List Simulation Personalities`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Personalities`,"slug":`api-reference/endpoint/set-simulation-personalities`,"method":`PUT`,"path":`/v1/simulations/{simulation_id}/personalities`,"summary":`Set Simulation Personalities`,"params":[{"name":`simulation_id`,"in":`path`,"required":true}],"body":`{ "personality_ids": [ "" ] }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/create-customer-persona`,"method":`POST`,"path":`/v1/create-customer-persona`,"summary":`Create Customer Persona`,"params":[],"body":`{ "agent_id": 123, "name": "", "description": "", "goal": "" }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/update-customer-persona`,"method":`PUT`,"path":`/v1/update-customer-persona/{persona_id}`,"summary":`Update Customer Persona`,"params":[{"name":`persona_id`,"in":`path`,"required":true}],"body":`{ "name": "", "description": "", "goal": "" }`,"bodyType":`application/json`},{"group":`Personalities`,"slug":`api-reference/endpoint/get-customer-persona`,"method":`GET`,"path":`/v1/customer-persona/{persona_id}`,"summary":`Get Customer Persona`,"params":[{"name":`persona_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Personalities`,"slug":`api-reference/endpoint/get-customer-persona-by-agent`,"method":`GET`,"path":`/v1/customer-personas-by-agent/{agent_id}`,"summary":`Get Customer Personas By Agent`,"params":[{"name":`agent_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Personalities`,"slug":`api-reference/endpoint/delete-customer-persona`,"method":`DELETE`,"path":`/v1/customer-persona/{persona_id}`,"summary":`Delete Customer Persona`,"params":[{"name":`persona_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Communities`,"slug":`api-reference/endpoint/create-community`,"method":`POST`,"path":`/v1/create-community`,"summary":`Create Community`,"params":[],"body":`{ "title": "", "description": "", "digital_human_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Communities`,"slug":`api-reference/endpoint/update-community`,"method":`PUT`,"path":`/v1/update-community/{community_id}`,"summary":`Update Community`,"params":[{"name":`community_id`,"in":`path`,"required":true}],"body":`{ "title": "", "description": "", "digital_human_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Communities`,"slug":`api-reference/endpoint/add-to-community`,"method":`PUT`,"path":`/v1/add-to-community/{community_id}`,"summary":`Add Digital Humans To Community`,"params":[{"name":`community_id`,"in":`path`,"required":true}],"body":`{ "digital_human_ids": [ 123 ] }`,"bodyType":`application/json`},{"group":`Communities`,"slug":`api-reference/endpoint/get-community`,"method":`GET`,"path":`/v1/community/{community_id}`,"summary":`Get Community`,"params":[{"name":`community_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Communities`,"slug":`api-reference/endpoint/get-communities`,"method":`GET`,"path":`/v1/communities`,"summary":`Get Communities`,"params":[{"name":`digital_human_id`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Communities`,"slug":`api-reference/endpoint/delete-community`,"method":`DELETE`,"path":`/v1/community/{community_id}`,"summary":`Delete Community`,"params":[{"name":`community_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Custom Background Noises`,"slug":`api-reference/endpoint/list-custom-background-noises`,"method":`GET`,"path":`/v1/custom-background-noises`,"summary":`List Custom Background Noises`,"params":[],"body":null,"bodyType":null},{"group":`Custom Background Noises`,"slug":`api-reference/endpoint/create-custom-background-noise-upload-url`,"method":`POST`,"path":`/v1/custom-background-noises/upload-url`,"summary":`Create Custom Background Noise Upload Url`,"params":[],"body":`{ "filename": "" }`,"bodyType":`application/json`},{"group":`Custom Background Noises`,"slug":`api-reference/endpoint/create-custom-background-noise`,"method":`POST`,"path":`/v1/custom-background-noises`,"summary":`Create Custom Background Noise`,"params":[],"body":`{ "name": "", "storage_path": "" }`,"bodyType":`application/json`},{"group":`Custom Background Noises`,"slug":`api-reference/endpoint/update-custom-background-noise`,"method":`PATCH`,"path":`/v1/custom-background-noises/{noise_id}`,"summary":`Update Custom Background Noise`,"params":[{"name":`noise_id`,"in":`path`,"required":true}],"body":`{ "name": "" }`,"bodyType":`application/json`},{"group":`Custom Background Noises`,"slug":`api-reference/endpoint/delete-custom-background-noise`,"method":`DELETE`,"path":`/v1/custom-background-noises/{noise_id}`,"summary":`Delete Custom Background Noise`,"params":[{"name":`noise_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Scenario Builder`,"slug":`api-reference/endpoint/create-scenario`,"method":`POST`,"path":`/v1/scenario`,"summary":`Create Workflow V2`,"params":[],"body":`{ "agent_ids": [], "definition": { "edges": [ { "id": "e-wf-start-n-greet", "source": "wf-start", "target": "n-greet" } ], "nodes": [ { "data": { "id": "wf-start" }, "deletable": false, "draggable": true, "id": "wf-start", "position": { "x": 100, "y": 50 }, "type": "start" }, { "data": { "criteria": "Greet the caller and offer help", "id": "n-greet", "speaker": "agent", "turn": 0, "type": "message" }, "id": "n-greet", "position": { "x": 200, "y": 180 }, "type": "single" } ] }, "description": "Password reset IVR", "name": "Support reset flow" }`,"bodyType":`application/json`},{"group":`Scenario Builder`,"slug":`api-reference/endpoint/list-scenarios`,"method":`GET`,"path":`/v1/scenario`,"summary":`List Workflows V2`,"params":[{"name":`agent_id`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Scenario Builder`,"slug":`api-reference/endpoint/get-scenario`,"method":`GET`,"path":`/v1/scenario/{workflow_id}`,"summary":`Get Workflow V2`,"params":[{"name":`workflow_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Scenario Builder`,"slug":`api-reference/endpoint/update-scenario`,"method":`PUT`,"path":`/v1/scenario/{workflow_id}`,"summary":`Update Workflow V2`,"params":[{"name":`workflow_id`,"in":`path`,"required":true}],"body":`{ "name": "", "agent_ids": [ 123 ], "description": "", "definition": {} }`,"bodyType":`application/json`},{"group":`Scenario Builder`,"slug":`api-reference/endpoint/delete-scenario`,"method":`DELETE`,"path":`/v1/scenario/{workflow_id}`,"summary":`Delete Workflow V2`,"params":[{"name":`workflow_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Schedules`,"slug":`api-reference/endpoint/create-schedule`,"method":`POST`,"path":`/v1/create-schedule`,"summary":`Create Schedule`,"params":[],"body":`{ "timezone": "", "simulation_id": "", "schedule": { "window": { "days": [ "monday" ], "start_time": "", "end_time": "" }, "frequency": "", "interval": 123 }, "enabled": true }`,"bodyType":`application/json`},{"group":`Schedules`,"slug":`api-reference/endpoint/list-schedules`,"method":`GET`,"path":`/v1/schedules`,"summary":`List Schedules`,"params":[],"body":null,"bodyType":null},{"group":`Schedules`,"slug":`api-reference/endpoint/get-schedule`,"method":`GET`,"path":`/v1/schedule/{schedule_id}`,"summary":`Get Schedule`,"params":[{"name":`schedule_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Schedules`,"slug":`api-reference/endpoint/update-schedule`,"method":`PUT`,"path":`/v1/update-schedule/{schedule_id}`,"summary":`Update Schedule`,"params":[{"name":`schedule_id`,"in":`path`,"required":true}],"body":`{ "timezone": "", "schedule": { "window": { "days": [ "monday" ], "start_time": "", "end_time": "" }, "frequency": "", "interval": 123 }, "enabled": true }`,"bodyType":`application/json`},{"group":`Schedules`,"slug":`api-reference/endpoint/delete-schedule`,"method":`DELETE`,"path":`/v1/delete-schedule/{schedule_id}`,"summary":`Delete Schedule`,"params":[{"name":`schedule_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Red Teaming`,"slug":`api-reference/endpoint/start-red-team-simulation`,"method":`POST`,"path":`/v1/red-team-simulations`,"summary":`Start Simulation`,"params":[],"body":`{ "agent_id": 123, "config": {}, "confirmed": false }`,"bodyType":`application/json`},{"group":`Red Teaming`,"slug":`api-reference/endpoint/list-red-team-simulations`,"method":`GET`,"path":`/v1/red-team-simulations`,"summary":`List Simulations`,"params":[{"name":`agent_id`,"in":`query`,"required":false},{"name":`status`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Red Teaming`,"slug":`api-reference/endpoint/get-red-team-simulation`,"method":`GET`,"path":`/v1/red-team-simulations/{test_id}`,"summary":`Get Simulation`,"params":[{"name":`test_id`,"in":`path`,"required":true},{"name":`by`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Red Teaming`,"slug":`api-reference/endpoint/stop-red-team-simulation`,"method":`POST`,"path":`/v1/red-team-simulations/{test_id}/stop`,"summary":`Stop Simulation`,"params":[{"name":`test_id`,"in":`path`,"required":true},{"name":`by`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Red Teaming`,"slug":`api-reference/endpoint/get-red-team-entitlements`,"method":`GET`,"path":`/v1/red-team-simulations/entitlements`,"summary":`Get Entitlements`,"params":[],"body":null,"bodyType":null},{"group":`Metrics`,"slug":`api-reference/endpoint/create-custom-metric`,"method":`POST`,"path":`/v1/create-metric`,"summary":`Create Custom Metric`,"params":[],"body":`{ "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_id": 123, "agent_ids": [ 123 ], "name": "", "prompt": "", "summary": "", "metric_type": "llm_judge", "settings": {}, "eval_segment": "agent", "scope": "observability", "response_type": "pass_fail", "min_value": 1.5, "max_value": 1.5, "category": "", "tags": [ "" ], "scoring_guidance": "", "eval_modality": "AUDIO", "model": "", "audio_model": "", "temperature": 1.5, "enum_options": [ "" ], "tool_names": [ "" ], "json_schema": {}, "allow_not_applicable": false, "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }`,"bodyType":`application/json`},{"group":`Metrics`,"slug":`api-reference/endpoint/create-custom-metrics`,"method":`POST`,"path":`/v1/create-metrics`,"summary":`Create Custom Metrics`,"params":[],"body":`{ "metrics": [ { "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_id": 123, "agent_ids": [ 123 ], "name": "", "prompt": "", "summary": "", "metric_type": "llm_judge", "settings": {}, "eval_segment": "agent", "scope": "observability", "response_type": "pass_fail", "min_value": 1.5, "max_value": 1.5, "category": "", "tags": [ "" ], "scoring_guidance": "", "eval_modality": "AUDIO", "model": "", "audio_model": "", "temperature": 1.5, "enum_options": [ "" ], "tool_names": [ "" ], "json_schema": {}, "allow_not_applicable": false, "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } ] }`,"bodyType":`application/json`},{"group":`Metrics`,"slug":`api-reference/endpoint/update-custom-metric`,"method":`PUT`,"path":`/v1/update-metric/{metric_id}`,"summary":`Update Custom Metric`,"params":[{"name":`metric_id`,"in":`path`,"required":true}],"body":`{ "bluejay_as_code_id": "", "name": "", "prompt": "", "summary": "", "metric_type": "", "settings": {}, "eval_segment": "agent", "scope": "observability", "response_type": "pass_fail", "agent_ids": [ 123 ], "min_value": 1.5, "max_value": 1.5, "category": "", "tags": [ "" ], "scoring_guidance": "", "eval_modality": "AUDIO", "model": "", "audio_model": "", "temperature": 1.5, "enum_options": [ "" ], "tool_names": [ "" ], "json_schema": {}, "allow_not_applicable": true }`,"bodyType":`application/json`},{"group":`Metrics`,"slug":`api-reference/endpoint/update-custom-metrics`,"method":`PUT`,"path":`/v1/update-metrics`,"summary":`Bulk Update Custom Metrics`,"params":[],"body":`{ "metric_ids": [ "" ], "updates": { "tags": [ "" ], "agent_ids": [ 123 ], "eval_modality": "AUDIO", "eval_segment": "agent", "scope": "observability", "model": "", "audio_model": "", "temperature": 1.5, "allow_not_applicable": true } }`,"bodyType":`application/json`},{"group":`Metrics`,"slug":`api-reference/endpoint/get-custom-metric`,"method":`GET`,"path":`/v1/metric/{metric_id}`,"summary":`Get Custom Metric`,"params":[{"name":`metric_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics`,"slug":`api-reference/endpoint/get-custom-metrics`,"method":`GET`,"path":`/v1/metrics`,"summary":`Get Custom Metrics`,"params":[{"name":`agent_id`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false},{"name":`page_size`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Metrics`,"slug":`api-reference/endpoint/get-custom-metrics-by-agent`,"method":`GET`,"path":`/v1/custom-metrics-by-agent/{agent_id}`,"summary":`Get Custom Metrics By Agent`,"params":[{"name":`agent_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics`,"slug":`api-reference/endpoint/delete-custom-metric`,"method":`DELETE`,"path":`/v1/metric/{metric_id}`,"summary":`Delete Custom Metric`,"params":[{"name":`metric_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics`,"slug":`api-reference/endpoint/delete-custom-metrics`,"method":`POST`,"path":`/v1/delete-metrics`,"summary":`Bulk Delete Custom Metrics`,"params":[],"body":`{ "custom_metric_ids": [ "" ] }`,"bodyType":`application/json`},{"group":`Logs`,"slug":`api-reference/endpoint/evaluate`,"method":`POST`,"path":`/v1/evaluate`,"summary":`Evaluate`,"params":[],"body":`{ "agent_id": "", "recording_url": "https://example.com", "recording_base64": "", "start_time_utc": "2026-01-01T00:00:00Z", "participants": [ { "role": "AGENT", "name": "", "spoke_first": false, "phone_number": "" } ], "call_direction": "INBOUND", "interface": "PHONE", "transcript_url": "https://example.com", "transcript": [ { "start_offset_ms": 123, "end_offset_ms": 123, "speaker": "AGENT", "utterance": "", "filler_utterance": true } ], "tool_calls": [ { "name": "", "start_offset_ms": 123, "description": "", "parameters": {}, "output": null } ], "events": [ { "title": "", "start_offset_ms": 123, "description": "", "end_offset_ms": 123, "tags": [ "" ], "metadata": {} } ], "tags": [ "" ], "trace_id": "", "created_at": "2026-01-01T00:00:00Z", "metadata": {}, "webhook_tag": "", "custom_metrics": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "custom_metric_tags": [ "" ], "label": "", "version": 123, "enable_phrase_latencies": true, "conversation_ended_by": "AGENT", "multichannel": false }`,"bodyType":`application/json`},{"group":`Logs`,"slug":`api-reference/endpoint/re-evaluate`,"method":`POST`,"path":`/v1/re-evaluate/{conversation_id}`,"summary":`Re Evaluate`,"params":[{"name":`conversation_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/list-conversations`,"method":`GET`,"path":`/v1/observability/conversations`,"summary":`Query Observability Conversations`,"params":[{"name":`status`,"in":`query`,"required":false},{"name":`agent_ids`,"in":`query`,"required":false},{"name":`label_ids`,"in":`query`,"required":false},{"name":`initiation_direction`,"in":`query`,"required":false},{"name":`caller_number`,"in":`query`,"required":false},{"name":`duration_min`,"in":`query`,"required":false},{"name":`duration_max`,"in":`query`,"required":false},{"name":`tags`,"in":`query`,"required":false},{"name":`conversation_ids`,"in":`query`,"required":false},{"name":`issue_ids`,"in":`query`,"required":false},{"name":`interface`,"in":`query`,"required":false},{"name":`label`,"in":`query`,"required":false},{"name":`metadata_path`,"in":`query`,"required":false},{"name":`metadata_value`,"in":`query`,"required":false},{"name":`metric_name`,"in":`query`,"required":false},{"name":`metric_id`,"in":`query`,"required":false},{"name":`metric_value`,"in":`query`,"required":false},{"name":`metric_min`,"in":`query`,"required":false},{"name":`metric_max`,"in":`query`,"required":false},{"name":`group_by`,"in":`query`,"required":false},{"name":`last`,"in":`query`,"required":false},{"name":`sort_order`,"in":`query`,"required":false},{"name":`page_size`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/get-conversation`,"method":`GET`,"path":`/v1/observability/conversations/{conversation_id}`,"summary":`Get Observability Conversation`,"params":[{"name":`conversation_id`,"in":`path`,"required":true},{"name":`include_transcript`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/retrieve-call-log`,"method":`GET`,"path":`/v1/retrieve-call-log/{call_id}`,"summary":`Retrieve Call Log`,"params":[{"name":`call_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/retrieve-call-logs`,"method":`GET`,"path":`/v1/retrieve-call-logs/{agent_id}`,"summary":`Deprecated: use GET /v1/observability/conversations`,"params":[{"name":`agent_id`,"in":`path`,"required":true},{"name":`label`,"in":`query`,"required":false},{"name":`page_size`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false},{"name":`last`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/delete-call-log`,"method":`DELETE`,"path":`/v1/call-log/{call_id}`,"summary":`Delete Call Log`,"params":[{"name":`call_id`,"in":`path`,"required":true},{"name":`recording_only`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Logs`,"slug":`api-reference/endpoint/translate-transcript`,"method":`POST`,"path":`/v1/translate-transcript`,"summary":`Translate a call transcript`,"params":[],"body":`{ "simulation_result_id": 123, "target_language": "en" }`,"bodyType":`application/json`},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/list-uptime-monitors`,"method":`GET`,"path":`/v1/uptime/monitors`,"summary":`List Uptime Monitors`,"params":[],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/get-uptime-monitor`,"method":`GET`,"path":`/v1/uptime/monitors/{monitor_id}`,"summary":`Get Uptime Monitor`,"params":[{"name":`monitor_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/create-uptime-monitor`,"method":`POST`,"path":`/v1/uptime/monitors`,"summary":`Create Uptime Monitor`,"params":[],"body":`{ "agent_id": 123, "frequency": "5m", "active_window": { "days": [ "monday" ], "start_time": "", "end_time": "", "timezone": "" }, "checks": [ {} ], "notifications": {}, "enabled": true, "start_at": "" }`,"bodyType":`application/json`},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/update-uptime-monitor`,"method":`PUT`,"path":`/v1/uptime/monitors/{monitor_id}`,"summary":`Update Uptime Monitor`,"params":[{"name":`monitor_id`,"in":`path`,"required":true}],"body":`{ "agent_id": 123, "frequency": "", "active_window": { "days": [ "monday" ], "start_time": "", "end_time": "", "timezone": "" }, "checks": [ {} ], "notifications": {}, "enabled": true, "start_at": "" }`,"bodyType":`application/json`},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/delete-uptime-monitor`,"method":`DELETE`,"path":`/v1/uptime/monitors/{monitor_id}`,"summary":`Delete Uptime Monitor`,"params":[{"name":`monitor_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/get-uptime-monitor-series`,"method":`GET`,"path":`/v1/uptime/monitors/{monitor_id}/series`,"summary":`Get Uptime Monitor Series`,"params":[{"name":`monitor_id`,"in":`path`,"required":true},{"name":`days`,"in":`query`,"required":false},{"name":`bucket`,"in":`query`,"required":false},{"name":`check`,"in":`query`,"required":false},{"name":`label`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/resolve-uptime-incidents`,"method":`POST`,"path":`/v1/uptime/monitors/{monitor_id}/incidents/resolve`,"summary":`Resolve Uptime Incidents`,"params":[{"name":`monitor_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/resolve-uptime-check`,"method":`POST`,"path":`/v1/uptime/monitors/{monitor_id}/checks/{check_id}/resolve`,"summary":`Resolve Uptime Check`,"params":[{"name":`monitor_id`,"in":`path`,"required":true},{"name":`check_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/unresolve-uptime-check`,"method":`POST`,"path":`/v1/uptime/monitors/{monitor_id}/checks/{check_id}/unresolve`,"summary":`Unresolve Uptime Check`,"params":[{"name":`monitor_id`,"in":`path`,"required":true},{"name":`check_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Uptime Monitors`,"slug":`api-reference/endpoint/get-uptime-check-transcript`,"method":`GET`,"path":`/v1/uptime/monitors/{monitor_id}/checks/{check_id}/transcript`,"summary":`Get Uptime Check Transcript`,"params":[{"name":`monitor_id`,"in":`path`,"required":true},{"name":`check_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Issues`,"slug":`api-reference/endpoint/list-issues`,"method":`GET`,"path":`/v1/observability/issues`,"summary":`List observability issues`,"params":[{"name":`status`,"in":`query`,"required":false},{"name":`priority`,"in":`query`,"required":false},{"name":`type`,"in":`query`,"required":false},{"name":`assignee_id`,"in":`query`,"required":false},{"name":`limit`,"in":`query`,"required":false},{"name":`offset`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Issues`,"slug":`api-reference/endpoint/get-issue`,"method":`GET`,"path":`/v1/observability/issues/{issue_id}`,"summary":`Get one observability issue`,"params":[{"name":`issue_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Issues`,"slug":`api-reference/endpoint/update-issue`,"method":`PUT`,"path":`/v1/observability/issues/{issue_id}`,"summary":`Update an observability issue`,"params":[{"name":`issue_id`,"in":`path`,"required":true}],"body":`{ "status": "", "priority": "", "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "due_date": "2026-01-01" }`,"bodyType":`application/json`},{"group":`Alerts`,"slug":`api-reference/endpoint/create-alert`,"method":`POST`,"path":`/v1/create-alert`,"summary":`Create Alert`,"params":[],"body":`{ "sample_size": 123, "name": "", "description": "", "is_enabled": true, "entity_type": "standard_metric", "entity_field": "", "operator": "equals", "comparison_value": "", "notification_channels": [ { "type": "", "target": "" } ], "applies_to_all_agents": true, "agent_ids": [ 123 ], "simulation_id": 123, "evaluation_scope": "per_test_result", "aggregation": "none", "threshold_time_interval": 123, "min_events": 123, "min_events_type": "events", "source_scope": "all" }`,"bodyType":`application/json`},{"group":`Alerts`,"slug":`api-reference/endpoint/update-alert`,"method":`PUT`,"path":`/v1/update-alert/{alert_id}`,"summary":`Update Alert`,"params":[{"name":`alert_id`,"in":`path`,"required":true}],"body":`{ "sample_size": 123, "name": "", "description": "", "is_enabled": true, "entity_type": "standard_metric", "entity_field": "", "operator": "equals", "comparison_value": "", "notification_channels": [ { "type": "", "target": "" } ], "applies_to_all_agents": true, "agent_ids": [ 123 ], "simulation_id": 123, "evaluation_scope": "per_test_result", "aggregation": "none", "threshold_time_interval": 123, "min_events": 123, "min_events_type": "events", "source_scope": "all" }`,"bodyType":`application/json`},{"group":`Alerts`,"slug":`api-reference/endpoint/get-alerts`,"method":`GET`,"path":`/v1/alerts`,"summary":`Get Alerts`,"params":[{"name":`source_scope`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Alerts`,"slug":`api-reference/endpoint/get-alert-results`,"method":`GET`,"path":`/v1/alerts/{alert_id}/results`,"summary":`Get Alert Results`,"params":[{"name":`alert_id`,"in":`path`,"required":true},{"name":`source`,"in":`query`,"required":false},{"name":`page_size`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Alerts`,"slug":`api-reference/endpoint/delete-alert`,"method":`DELETE`,"path":`/v1/alert/{alert_id}`,"summary":`Delete Alert`,"params":[{"name":`alert_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/list-dashboards`,"method":`GET`,"path":`/v1/dashboards`,"summary":`List Dashboards`,"params":[{"name":`data_type`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/create-dashboard`,"method":`POST`,"path":`/v1/dashboards`,"summary":`Create Dashboard`,"params":[],"body":`{ "name": "", "description": "", "data_type": "observability" }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/get-dashboard`,"method":`GET`,"path":`/v1/dashboards/{dashboard_id}`,"summary":`Get Dashboard`,"params":[{"name":`dashboard_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/update-dashboard`,"method":`PUT`,"path":`/v1/dashboards/{dashboard_id}`,"summary":`Update Dashboard`,"params":[{"name":`dashboard_id`,"in":`path`,"required":true}],"body":`{ "name": "", "description": "" }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/update-dashboard-layout`,"method":`PUT`,"path":`/v1/dashboards/{dashboard_id}/layout`,"summary":`Update Dashboard Layout`,"params":[{"name":`dashboard_id`,"in":`path`,"required":true}],"body":`{ "layouts": [ { "widget_id": "", "layout": { "x": 123, "y": 123, "w": 123, "h": 123 } } ] }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/duplicate-dashboard`,"method":`POST`,"path":`/v1/dashboards/{dashboard_id}/duplicate`,"summary":`Duplicate Dashboard`,"params":[{"name":`dashboard_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/delete-dashboard`,"method":`DELETE`,"path":`/v1/dashboards/{dashboard_id}`,"summary":`Delete Dashboard`,"params":[{"name":`dashboard_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/list-widgets`,"method":`GET`,"path":`/v1/widgets`,"summary":`List Widgets`,"params":[{"name":`data_type`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/create-widget`,"method":`POST`,"path":`/v1/widgets`,"summary":`Create Widget`,"params":[],"body":`{ "name": "", "description": "", "chart_type": "line", "chart_mode": "time_series", "data_type": "observability", "bar_mode": "stacked", "aggregation": [ "count" ], "time_bucket": "hour", "group_by": "agent", "simulation_ids": [ 123 ], "show_indeterminate": false, "filters": [ null ], "column_visibility": { "key": true }, "color_overrides": { "key": "" }, "center_label": { "slice": "", "clamp_pct": 1.5, "label": "", "benchmark": 1.5, "compare_previous": true, "unit": "" }, "show_legend": true, "metrics": [ { "metric": "", "custom_metric_id": "", "goal": "", "tool_call_id": "", "metadata_path": "", "threshold_operator": "lt", "threshold_value": 1.5, "metadata_type": "" } ], "dashboard_id": "" }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/get-widget`,"method":`GET`,"path":`/v1/widgets/{widget_id}`,"summary":`Get Widget`,"params":[{"name":`widget_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Dashboards`,"slug":`api-reference/endpoint/update-widget`,"method":`PUT`,"path":`/v1/widgets/{widget_id}`,"summary":`Update Widget`,"params":[{"name":`widget_id`,"in":`path`,"required":true}],"body":`{ "name": "", "description": "", "chart_type": "line", "chart_mode": "time_series", "bar_mode": "stacked", "aggregation": [ "count" ], "time_bucket": "hour", "group_by": "agent", "simulation_ids": [ 123 ], "show_indeterminate": false, "filters": [ null ], "column_visibility": { "key": true }, "color_overrides": { "key": "" }, "center_label": { "slice": "", "clamp_pct": 1.5, "label": "", "benchmark": 1.5, "compare_previous": true, "unit": "" }, "show_legend": true, "metrics": [ { "metric": "", "custom_metric_id": "", "goal": "", "tool_call_id": "", "metadata_path": "", "threshold_operator": "lt", "threshold_value": 1.5, "metadata_type": "" } ] }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/duplicate-widget`,"method":`POST`,"path":`/v1/widgets/{widget_id}/duplicate`,"summary":`Duplicate Widget`,"params":[{"name":`widget_id`,"in":`path`,"required":true}],"body":`{ "dashboard_id": "" }`,"bodyType":`application/json`},{"group":`Dashboards`,"slug":`api-reference/endpoint/delete-widget`,"method":`DELETE`,"path":`/v1/widgets/{widget_id}`,"summary":`Delete Widget`,"params":[{"name":`widget_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Traces`,"slug":`api-reference/endpoint/list-traces`,"method":`GET`,"path":`/v1/traces`,"summary":`Get All Traces`,"params":[{"name":`limit`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Traces`,"slug":`api-reference/endpoint/get-trace`,"method":`POST`,"path":`/v1/traces/{trace_id}`,"summary":`Get Trace`,"params":[{"name":`trace_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Traces`,"slug":`api-reference/endpoint/get-span`,"method":`POST`,"path":`/v1/spans/{trace_id}/{span_id}`,"summary":`Get Span`,"params":[{"name":`trace_id`,"in":`path`,"required":true},{"name":`span_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Self-Improve`,"slug":`api-reference/endpoint/start-self-improve-run`,"method":`POST`,"path":`/v1/self-improve/runs`,"summary":`Start Run`,"params":[],"body":`{ "agent_id": 123, "simulation_id": 123, "target_pass_rate": 0.9, "max_iterations": 5, "min_improvement": 0.02, "metric_count": 5, "success_metric_ids": [ "" ], "confirmed": false }`,"bodyType":`application/json`},{"group":`Self-Improve`,"slug":`api-reference/endpoint/list-self-improve-runs`,"method":`GET`,"path":`/v1/self-improve/runs`,"summary":`List Runs`,"params":[{"name":`agent_id`,"in":`query`,"required":false},{"name":`status`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Self-Improve`,"slug":`api-reference/endpoint/get-self-improve-run`,"method":`GET`,"path":`/v1/self-improve/runs/{run_id}`,"summary":`Get Run`,"params":[{"name":`run_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Self-Improve`,"slug":`api-reference/endpoint/stop-self-improve-run`,"method":`POST`,"path":`/v1/self-improve/runs/{run_id}/stop`,"summary":`Stop Run`,"params":[{"name":`run_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/list-labs`,"method":`GET`,"path":`/v1/metrics-lab/labs`,"summary":`List Labs`,"params":[{"name":`page_size`,"in":`query`,"required":false},{"name":`page`,"in":`query`,"required":false}],"body":null,"bodyType":null},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/create-lab`,"method":`POST`,"path":`/v1/metrics-lab/lab`,"summary":`Create Lab`,"params":[],"body":`{ "name": "", "description": "", "tags": [ "" ], "conversations": [ { "call_id": "", "test_result_id": 123 } ], "metric_ids": [ "" ] }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/get-lab`,"method":`GET`,"path":`/v1/metrics-lab/lab/{lab_id}`,"summary":`Get Lab Detail`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/update-lab`,"method":`PUT`,"path":`/v1/metrics-lab/lab/{lab_id}`,"summary":`Update Lab`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "name": "", "description": "" }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/update-lab-settings`,"method":`PUT`,"path":`/v1/metrics-lab/lab/{lab_id}/settings`,"summary":`Update Lab Settings`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "fuzzy_alignment": {} }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/delete-lab`,"method":`DELETE`,"path":`/v1/metrics-lab/lab/{lab_id}`,"summary":`Delete Lab`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":null,"bodyType":null},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/add-metrics-to-lab`,"method":`POST`,"path":`/v1/metrics-lab/lab/{lab_id}/metrics`,"summary":`Add Metrics To Lab`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "lab_id": "", "metric_ids": [ "" ], "evaluate_conversations": false }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/add-conversations-to-lab`,"method":`POST`,"path":`/v1/metrics-lab/lab/{lab_id}/conversations`,"summary":`Add Conversations To Lab`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "lab_id": "", "conversations": [ { "call_id": "", "test_result_id": 123 } ] }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/remove-conversations-from-lab`,"method":`DELETE`,"path":`/v1/metrics-lab/lab/{lab_id}/conversations`,"summary":`Remove Conversations From Lab`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "lab_id": "", "conversations": [ { "call_id": "", "test_result_id": 123 } ] }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/evaluate-lab-conversation`,"method":`POST`,"path":`/v1/metrics-lab/evaluate-conversation`,"summary":`Evaluate Conversation`,"params":[],"body":`{ "lab_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "conversation": { "type": "obs_conversation", "id": "" }, "metrics": { "type": "custom_metric", "custom_metric_ids": [ "" ], "custom_metric_revision_id": "" } }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/set-human-evaluation`,"method":`PUT`,"path":`/v1/metrics-lab/lab/{lab_id}/human-evaluation`,"summary":`Create Or Update Human Evaluation`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "custom_metric_id": "", "call_id": "", "test_result_id": 123, "human_response_value": "", "human_reasoning": "" }`,"bodyType":`application/json`},{"group":`Metrics Lab`,"slug":`api-reference/endpoint/create-metric-revision`,"method":`POST`,"path":`/v1/metrics-lab/lab/{lab_id}/metric-revisions`,"summary":`Create Metric Revision`,"params":[{"name":`lab_id`,"in":`path`,"required":true}],"body":`{ "custom_metric_id": "", "description": "", "scoring_guidance": "", "eval_route": "", "model": "", "audio_model": "", "temperature": 1.5, "allow_not_applicable": false }`,"bodyType":`application/json`},{"group":`Agents`,"slug":`api-reference/endpoint/add-agent`,"method":`POST`,"path":`/v1/add-agent`,"summary":`Add Agent`,"params":[],"body":`{ "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "", "system_prompt": "", "phone_number": "", "goals": [ "" ], "type": "INBOUND", "connection_type": "SMS", "mode": "VOICE", "keyterms": [ "" ], "follow_up_sms_sender_numbers": [ "" ], "external_agent_id": "", "labels": [ "" ], "folder": "", "websocket_url": "", "websocket_username": "", "websocket_password": "", "sip_uri": "", "sip_username": "", "sip_password": "", "custom_sip_headers": { "key": "" }, "dynamic_sip_webhook_url": "", "outbound_trigger_webhook_url": "", "outbound_trigger_payload_template": {}, "redact_pii": false, "livekit_agent_name": "", "livekit_metadata": {}, "livekit_customer_tool_topic": "", "livekit_token_webhook_url": "", "livekit_token_webhook_auth": "", "pipecat_agent_name": "", "pipecat_agent_configuration": {}, "pipecat_room_properties": {}, "http_webhook": "", "http_webhook_sync_reply": true, "voice_provider": "", "provider_id": "", "eleven_labs_agent_id": "", "retell_agent_id": "", "vapi_assistant_id": "", "ces_app_id": "", "ces_deployment_id": "", "dfcx_project_id": "", "dfcx_location": "", "dfcx_agent_id": "", "amelia_base_url": "", "amelia_domain_code": "", "amelia_flow_name": "", "amelia_agent_name": "", "kore_host": "", "kore_bot_id": "", "kore_client_id": "", "kore_client_secret": "", "openai_base_url": "", "openai_api_key": "", "openai_model": "", "openai_realtime_url": "", "openai_realtime_session": {}, "openai_prompt_id": "", "openai_prompt_version": "", "email_address": "", "email_reply_addresses": [ "" ], "bland_pathway_id": "", "bland_agent_id": "", "sierra_agent_token": "", "sierra_release": "", "sierra_agent_parameters": {}, "bland_call_settings": {}, "provider_request_data": {}, "enable_outbound_call_auto_start": true, "simulations_disabled": false, "workflow": {}, "provider": "CUSTOM" }`,"bodyType":`application/json`},{"group":`Agents`,"slug":`api-reference/endpoint/update-agent`,"method":`POST`,"path":`/v1/update-agent`,"summary":`Update Agent`,"params":[],"body":`{ "bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "agent_id": "", "external_agent_id": "", "name": "", "system_prompt": "", "phone_number": "", "goals": [ "" ], "type": "INBOUND", "connection_type": "SMS", "mode": "VOICE", "keyterms": [ "" ], "follow_up_sms_sender_numbers": [ "" ], "folder": "", "websocket_url": "", "websocket_username": "", "websocket_password": "", "sip_uri": "", "sip_username": "", "sip_password": "", "custom_sip_headers": { "key": "" }, "dynamic_sip_webhook_url": "", "outbound_trigger_webhook_url": "", "outbound_trigger_payload_template": {}, "redact_pii": true, "livekit_agent_name": "", "livekit_metadata": {}, "livekit_customer_tool_topic": "", "livekit_token_webhook_url": "", "livekit_token_webhook_auth": "", "pipecat_agent_name": "", "pipecat_agent_configuration": {}, "pipecat_room_properties": {}, "http_webhook": "", "http_webhook_sync_reply": true, "voice_provider": "", "provider_id": "", "eleven_labs_agent_id": "", "retell_agent_id": "", "vapi_assistant_id": "", "ces_app_id": "", "ces_deployment_id": "", "dfcx_project_id": "", "dfcx_location": "", "dfcx_agent_id": "", "amelia_base_url": "", "amelia_domain_code": "", "amelia_flow_name": "", "amelia_agent_name": "", "kore_host": "", "kore_bot_id": "", "kore_client_id": "", "kore_client_secret": "", "openai_base_url": "", "openai_api_key": "", "openai_model": "", "openai_realtime_url": "

​Related

Related