Skip to main content
POST
/
v1
/
create-folder
Create Folder
curl --request POST \
  --url https://api.getbluejay.ai/v1/create-folder \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organization_id": "<string>",
  "created_at": "<string>"
}
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 Folder — POST /v1/create-folder

> **What this endpoint does:** Create a new folder for organizing agents. Returns the created folder details.

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

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

### Request Body (required fields)
```json
{
  "name": "example_name"
}
```

Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/create-folder. 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_folder(payload: dict, api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/create-folder"
    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.
Create a new folder for organizing agents within your organization.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Body

application/json
​
name
string
required

Name of the folder

Response

Successful Response

​
id
string<uuid>
required

ID of the folder

​
name
string
required

Name of the folder

​
organization_id
string
required

Organization ID

​
created_at
string
required

Timestamp when the folder was created