Skip to main content
PUT
/
v1
/
folders
/
move-agent
Move Agent To Folder
curl --request PUT \
  --url https://api.getbluejay.ai/v1/folders/move-agent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "agent_id": 123,
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "agent_id": 123,
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "success"
}
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.

## Move Agent to Folder — PUT /v1/folders/move-agent

> **What this endpoint does:** Move an agent to a folder or disassociate it from any folder. - If folder_id is provided: Associates the agent with that folder - If folder_id is null: Disassociates the agent from any folder Both the agent and folder (if provided) must belong to the user's organization.

**Endpoint:** PUT `https://api.getbluejay.ai/v1/folders/move-agent`
**Auth:** `X-API-Key` header
**Content-Type:** application/json

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| agent_id | integer | ID of the agent to move |

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

### Request Body (required fields)
```json
{
  "agent_id": 123
}
```

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

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

def move_agent_to_folder(payload: dict, api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/folders/move-agent"
    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.
Associate an agent with a folder or disassociate it from any folder. Both the agent and folder (if provided) must belong to your organization.

Headers

X-API-Key
string
required

API key required to authenticate requests.

Body

application/json
agent_id
integer
required

ID of the agent to move

folder_id
string<uuid> | null

ID of the target folder (null to disassociate from any folder)

Response

Successful Response

agent_id
integer
required

ID of the agent

folder_id
string<uuid> | null

ID of the folder (null if disassociated)

status
string
default:success

Status of the operation