Skip to main content
GET
/
v1
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.getbluejay.ai/v1/agents/{agent_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "name": "<string>",
  "agent_description": "<string>",
  "knowledge_base": "<string>",
  "organization_id": "<string>",
  "mode": "VOICE",
  "id": "<string>",
  "goals": [
    "<string>"
  ],
  "type": "INBOUND",
  "connection_type": "SMS",
  "phone_number": "<string>",
  "websocket_url": "<string>",
  "redact_pii": true,
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "keyterms": [
    "<string>"
  ],
  "voice_provider": "<string>",
  "provider_id": "<string>",
  "websocket_username": "<string>",
  "websocket_password": "<string>",
  "external_agent_id": "<string>",
  "sip_uri": "<string>",
  "custom_sip_headers": {},
  "sip_username": "<string>",
  "sip_password": "<string>",
  "simulation_notifications": {},
  "livekit_agent_name": "<string>",
  "livekit_metadata": {},
  "livekit_customer_tool_topic": "<string>",
  "pipecat_agent_name": "<string>",
  "pipecat_agent_configuration": {},
  "pipecat_room_properties": {},
  "http_webhook": "<string>",
  "http_webhook_key": "<string>",
  "enable_outbound_call_auto_start": true
}
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.

## Get Agent — GET /v1/agents/{agent_id}

> **What this endpoint does:** Get an agent by ID.

**Endpoint:** GET `https://api.getbluejay.ai/v1/agents/{agent_id}`
**Auth:** `X-API-Key` header

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

### Example
**Simple GET:**
```python
import requests

def get_agent(agent_id: int, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/agents/{agent_id}"
    headers = {"X-API-Key": api_key}
    response = requests.get(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.
Given the agent ID, this endpoint returns the agent.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
agent_id
integer
required

Response

Successful Response

​
name
string
required
​
agent_description
string
required
​
knowledge_base
string
required
​
organization_id
string
required
​
mode
enum<string>
required

Enum representing the mode of agent

Available options:
VOICE,
TEXT
​
id
​
goals
string[] | null
​
type
enum<string> | null

Enum representing the type of agent

Available options:
INBOUND,
OUTBOUND
​
connection_type
enum<string> | null

Enum representing the connection type of the agent

Available options:
SMS,
HTTP_WEBHOOK,
PHONE,
SIP,
WEBSOCKET,
LIVEKIT,
PIPECAT
​
phone_number
string | null
​
websocket_url
string | null
​
redact_pii
boolean | null
​
folder_id
string<uuid> | null
​
created_at
string<date-time> | null
​
keyterms
string[] | null
​
voice_provider
string | null
​
provider_id
string | null
​
websocket_username
string | null
​
websocket_password
string | null
​
external_agent_id
string | null
​
sip_uri
string | null
​
custom_sip_headers
Custom Sip Headers · object
​
sip_username
string | null
​
sip_password
string | null
​
simulation_notifications
Simulation Notifications · object
​
livekit_agent_name
string | null
​
livekit_metadata
Livekit Metadata · object
​
livekit_customer_tool_topic
string | null
​
pipecat_agent_name
string | null
​
pipecat_agent_configuration
Pipecat Agent Configuration · object
​
pipecat_room_properties
Pipecat Room Properties · object
​
http_webhook
string | null
​
http_webhook_key
string | null
​
enable_outbound_call_auto_start
boolean | null