Create Community

Create a new community.

POST /v1/create-community

Create Community

cURL

curl --request POST \
  --url https://api.getbluejay.ai/v1/create-community \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "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.

## Create Community — POST /v1/create-community

> **What this endpoint does:** Create a new community.

**Endpoint:** POST `https://api.getbluejay.ai/v1/create-community`
**Auth:** `X-API-Key` header
**Content-Type:** application/json

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| title | string | Title of the community |

Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/create-community and include any optional parameters (e.g., `description`, `digital_human_ids`) that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.

### Request Body (required fields)
```json
{
  "title": "string"
}
```

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

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

def create_community(payload: dict, api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/create-community"
    headers = {"X-API-Key": api_key}
    response = requests.post(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 create a community as a way to organize your digital humans. Provide the necessary details to create a community.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Body

application/json

title · string · required

Title of the community

description · string | null

Description of the community

digital_human_ids · integer[] | null

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

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