Get Agent By External Id
curl --request GET \
--url https://api.getbluejay.ai/v1/agent-by-external-id/{external_id} \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"name": "<string>",
"agent_description": "<string>",
"organization_id": "<string>",
"mode": "VOICE",
"id": 123,
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "<string>",
"goals": [
"<string>"
],
"type": "INBOUND",
"connection_type": "SMS",
"phone_number": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"websocket_url": "<string>",
"redact_pii": true,
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_by_api_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_key": "<string>",
"http_webhook_sync_reply": true,
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"bland_persona_id": "<string>",
"bland_call_settings": {},
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"kore_inbound_token": "<string>",
"enable_outbound_call_auto_start": true,
"simulations_disabled": false,
"workflow": {},
"provider": "CUSTOM",
"red_team_profile": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Agents
Get Agent By External ID
Get an agent by external ID.
GET
/
v1
/
agent-by-external-id
/
{external_id}
Get Agent By External Id
curl --request GET \
--url https://api.getbluejay.ai/v1/agent-by-external-id/{external_id} \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"name": "<string>",
"agent_description": "<string>",
"organization_id": "<string>",
"mode": "VOICE",
"id": 123,
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "<string>",
"goals": [
"<string>"
],
"type": "INBOUND",
"connection_type": "SMS",
"phone_number": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"websocket_url": "<string>",
"redact_pii": true,
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_by_api_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_key": "<string>",
"http_webhook_sync_reply": true,
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"bland_persona_id": "<string>",
"bland_call_settings": {},
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"kore_inbound_token": "<string>",
"enable_outbound_call_auto_start": true,
"simulations_disabled": false,
"workflow": {},
"provider": "CUSTOM",
"red_team_profile": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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 By External ID — GET /v1/agent-by-external-id/{external_id}
> **What this endpoint does:** Get an agent by external ID.
**Endpoint:** GET `https://api.getbluejay.ai/v1/agent-by-external-id/{external_id}`
**Auth:** `X-API-Key` header
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| external_id | string | |
| X-API-Key | string | API key required to authenticate requests. |
### Example
**Simple GET:**
```python
import requests
def get_agent_by_external_id(external_id: str, api_key: str) -> dict:
url = f"https://api.getbluejay.ai/v1/agent-by-external-id/{external_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.
Path Parameters
Response
Successful Response
Enum representing the mode of agent
Available options:
VOICE, TEXT, EMAIL Enum representing the type of agent
Available options:
INBOUND, OUTBOUND Enum representing the connection type of the agent
Available options:
SMS, HTTP_WEBHOOK, PHONE, SIP, WEBSOCKET, LIVEKIT, PIPECAT, ELEVEN_LABS, RETELL, VAPI, KORE, OPENAI_CHAT, SIERRA_VOICE, AMELIA_CHAT, AMELIA_VOICE, GOOGLE_CES_CHAT, GOOGLE_CES_VOICE, GOOGLE_DFCX_VOICE, GOOGLE_DFCX_CHAT, BLAND_PHONE, BLAND_VOICE, BLAND_CHAT, EMAIL Source platform the agent's definition (system prompt, workflow) comes from.
Distinct from voice_provider (TTS/STT vendor) and provider_id (handle on that vendor) —
this identifies where the agent's behavior (prompt, multi-agent graph) is authored.
Available options:
CUSTOM, ELEVENLABS, VAPI, RETELL, GOOGLE_CES_VOICE, GOOGLE_CES_CHAT, GOOGLE_DFCX_VOICE, GOOGLE_DFCX_CHAT, AMELIA, BLAND