Push Bluejay As Code
curl --request POST \
--url https://api.getbluejay.ai/v1/bluejay-as-code \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"agents": [
{}
],
"simulations": [
{}
],
"digital_humans": [
{}
],
"custom_metrics": [
{}
]
}
'import requests
url = "https://api.getbluejay.ai/v1/bluejay-as-code"
payload = {
"agents": [{}],
"simulations": [{}],
"digital_humans": [{}],
"custom_metrics": [{}]
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agents: [{}], simulations: [{}], digital_humans: [{}], custom_metrics: [{}]})
};
fetch('https://api.getbluejay.ai/v1/bluejay-as-code', 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/bluejay-as-code",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agents' => [
[
]
],
'simulations' => [
[
]
],
'digital_humans' => [
[
]
],
'custom_metrics' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/bluejay-as-code"
payload := strings.NewReader("{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getbluejay.ai/v1/bluejay-as-code")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/bluejay-as-code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"errors": [
{
"entity_type": "<string>",
"entity_id": "<unknown>",
"errors": [
"<string>"
]
}
],
"actions": [],
"simulation_id": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Bluejay as Code
Push Bluejay as Code
Apply a Bluejay as Code payload to Bluejay.
POST
/
v1
/
bluejay-as-code
Push Bluejay As Code
curl --request POST \
--url https://api.getbluejay.ai/v1/bluejay-as-code \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"agents": [
{}
],
"simulations": [
{}
],
"digital_humans": [
{}
],
"custom_metrics": [
{}
]
}
'import requests
url = "https://api.getbluejay.ai/v1/bluejay-as-code"
payload = {
"agents": [{}],
"simulations": [{}],
"digital_humans": [{}],
"custom_metrics": [{}]
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agents: [{}], simulations: [{}], digital_humans: [{}], custom_metrics: [{}]})
};
fetch('https://api.getbluejay.ai/v1/bluejay-as-code', 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/bluejay-as-code",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agents' => [
[
]
],
'simulations' => [
[
]
],
'digital_humans' => [
[
]
],
'custom_metrics' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/bluejay-as-code"
payload := strings.NewReader("{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getbluejay.ai/v1/bluejay-as-code")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/bluejay-as-code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agents\": [\n {}\n ],\n \"simulations\": [\n {}\n ],\n \"digital_humans\": [\n {}\n ],\n \"custom_metrics\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"errors": [
{
"entity_type": "<string>",
"entity_id": "<unknown>",
"errors": [
"<string>"
]
}
],
"actions": [],
"simulation_id": 123
}{
"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.
## Push Bluejay as Code — POST /v1/bluejay-as-code
> **What this endpoint does:** Apply a Bluejay as Code payload to Bluejay. Each entity in the payload is matched by its `bluejay_as_code_id` — created if not found, updated if fields changed, left untouched if identical. Returns a list of actions taken (as human-readable strings), any validation errors, and the resolved `simulation_id` of the simulation in the bundle.
**Endpoint:** POST `https://api.getbluejay.ai/v1/bluejay-as-code`
**Auth:** `X-API-Key` header
**Content-Type:** application/json
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| agents | array | Agent objects in the bundle (typically one for a simulation push). |
| simulations | array | Simulation objects in the bundle (typically one for a simulation push). |
| digital_humans | array | Digital Human objects (can be empty). |
| custom_metrics | array | Custom metric objects (can be empty). |
Review the full schema at https://docs.getbluejay.ai/api-reference/endpoint/push-bluejay-as-code.
### Request Body (required fields)
```json
{
"agents": [ { "bluejay_as_code_id": "...", ... } ],
"simulations": [ { "bluejay_as_code_id": "...", ... } ],
"digital_humans": [ { "bluejay_as_code_id": "...", ... } ],
"custom_metrics": [ { "bluejay_as_code_id": "...", ... } ]
}
```
### Example
```python
import requests
def push_bluejay_as_code(payload: dict, api_key: str) -> dict:
url = "https://api.getbluejay.ai/v1/bluejay-as-code"
headers = {"X-API-Key": api_key, "Content-Type": "application/json"}
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).
- `bluejay_as_code_id` values must be stable UUIDs hardcoded in your config — never generate them dynamically at push time.
- Include error handling for 422: Validation Error and check `result["valid"]` before proceeding.
### 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.
Body
application/json