Skip to main content
DELETE
/
v1
/
community
/
{community_id}
Delete Community
curl --request DELETE \
  --url https://api.getbluejay.ai/v1/community/{community_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "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.

## Delete Community — DELETE /v1/community/{community_id}

> **What this endpoint does:** Delete a specific community by ID.

**Endpoint:** DELETE `https://api.getbluejay.ai/v1/community/{community_id}`
**Auth:** `X-API-Key` header

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

### Example
**DELETE request:**
```python
import requests

def delete_community(community_id: str, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/community/{community_id}"
    headers = {"X-API-Key": api_key}
    response = requests.delete(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 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 delete a community. Provide the community ID in the path to permanently remove the community.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
community_id
string<uuid>
required

Response

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