Create Customer Persona

Create a new customer persona.

POST /v1/create-customer-persona

Create Customer Persona

cURL

curl --request POST \
  --url https://api.getbluejay.ai/v1/create-customer-persona \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "goal": "<string>",
  "agent_id": 123
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "goal": "<string>",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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 Customer Persona — POST /v1/create-customer-persona

> **What this endpoint does:** Create a new customer persona.

**Endpoint:** POST `https://api.getbluejay.ai/v1/create-customer-persona`
**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 customer persona |
| description | string | Description of the customer persona |
| goal | string | Goal of the customer persona |

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

### Request Body (required fields)
```json
{
  "name": "example_name",
  "description": "string",
  "goal": "string"
}
```

Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/create-customer-persona. 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_customer_persona(payload: dict, api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/create-customer-persona"
    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 customer persona for your agent. Provide the necessary details to add a customer persona to your agent.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Body

application/json

name · string · required

Name of the customer persona

description · string · required

Description of the customer persona

goal · string · required

Goal of the customer persona

agent_id · integer | null

ID of the agent this persona belongs to

Response

200

application/json

Successful Response

Pydantic version of CustomerPersona for validation and serialization.

id · string<uuid> | null

created_at · string<date-time> | null

name · string | null

description · string | null

goal · string | null

org_id · string<uuid> | null