Get Digital Humans by Simulation

Get digital humans by simulation ID.

GET /v1/digital-humans-by-simulation/{simulation_id}

Get Digital Humans By Simulation

cURL

curl --request GET \
  --url https://api.getbluejay.ai/v1/digital-humans-by-simulation/{simulation_id} \
  --header 'X-API-Key: <x-api-key>'

200

{
  "digital_humans": [
    {
      "intent": "<string>",
      "success_criteria": "<string>",
      "id": 123,
      "tag": "<string>",
      "name": "<string>",
      "language": "en",
      "accent": "multilingual",
      "gender": "male",
      "background_noise": "<string>",
      "voice_speed": "<string>",
      "audio_quality": "<string>",
      "fluency": "<string>",
      "verbosity": "<string>",
      "phone_number": "<string>",
      "outbound_text_number": "<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,
      "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>",
          "occurrence_n": 1,
          "silence_duration": 1
        }
      ],
      "speaks_first_config": {
        "speaks_first": true,
        "mode": "custom",
        "message": "<string>"
      },
      "original_transcript": "<string>",
      "formatted_transcript": [
        {}
      ],
      "enriched_playback": [
        {}
      ],
      "workflow_v2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_path_index": 123,
      "livekit_metadata": {}
    }
  ],
  "total": 123,
  "simulation_id": 123
}

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.

## Get Digital Humans by Simulation — GET /v1/digital-humans-by-simulation/{simulation_id}

> **What this endpoint does:** Get digital humans by simulation ID.

**Endpoint:** GET `https://api.getbluejay.ai/v1/digital-humans-by-simulation/{simulation_id}`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| simulation_id | integer |  |
| X-API-Key | string | API key required to authenticate requests. |

### Example
**Simple GET:**
```python
import requests

def get_digital_humans_by_simulation(simulation_id: int, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/digital-humans-by-simulation/{simulation_id}"
    headers = {"X-API-Key": api_key}
    response = requests.get(url, headers=headers)
    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 404: Simulation not found or belongs to a different organization; 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.

This endpoint allows you to retrieve all digital humans associated with a specific simulation. Provide the simulation ID in the path to get a list of all digital humans configured for that simulation.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Path Parameters

simulation_id · integer · required

Response

200

application/json

Successful Response

Response model for listing digital humans by simulation.

digital_humans · DigitalHumanResponseData · object[] · required

List of digital humans

Show child attributes

total · integer · required

Total number of digital humans

simulation_id · integer · required

ID of the simulation