Add Digital Humans To Community

Add digital humans to an existing community without replacing the current list.

PUT /v1/add-to-community/{community_id}

Add Digital Humans To Community

cURL

curl --request PUT \
  --url https://api.getbluejay.ai/v1/add-to-community/{community_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "digital_human_ids": [
    123
  ]
}
'

200

{
  "id": "<string>",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "digital_human_ids": [
    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.

## Add Digital Humans To Community — PUT /v1/add-to-community/{community_id}

> **What this endpoint does:** Add digital humans to an existing community without replacing the current list.

**Endpoint:** PUT `https://api.getbluejay.ai/v1/add-to-community/{community_id}`
**Auth:** `X-API-Key` header
**Content-Type:** application/json

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| community_id | string |  |
| X-API-Key | string | API key required to authenticate requests. |
| digital_human_ids | array[integer] | List of digital human (test case) IDs to add to this community |

### Request Body (required fields)
```json
{
  "digital_human_ids": [
    123
  ]
}
```

Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/add-to-community. Include optional fields that serve the goal of setting up for testing and monitoring on Bluejay.

### Example
**PUT with body:**
```python
import requests

def add_digital_humans_to_community(community_id: str, payload: dict, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/add-to-community/{community_id}"
    headers = {"X-API-Key": api_key}
    response = requests.put(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 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 add digital humans to an existing community without replacing the current list. Provide the community ID in the path and the list of digital human IDs in the request body.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Path Parameters

community_id · string<uuid> · required

Body

application/json

digital_human_ids · integer[] · required

List of digital human (test case) IDs to add to this community

Response

200

application/json

Successful Response

Response model for community operations

id · string · required

Unique identifier for the community

title · string · required

Title of the community

created_at · string<date-time> · required

When this community was created

description · string | null

Description of the community

digital_human_ids · integer[]

List of digital human (test case) IDs associated with this community