Remove Digital Humans From Simulation
curl --request POST \
--url https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"digital_human_ids": [
123
]
}
'import requests
url = "https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans"
payload = { "digital_human_ids": [123] }
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({digital_human_ids: [123]})
};
fetch('https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans', 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/simulation/{simulation_id}/remove-digital-humans",
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([
'digital_human_ids' => [
123
]
]),
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/simulation/{simulation_id}/remove-digital-humans"
payload := strings.NewReader("{\n \"digital_human_ids\": [\n 123\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/simulation/{simulation_id}/remove-digital-humans")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"digital_human_ids\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans")
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 \"digital_human_ids\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Simulations
Remove Digital Humans from Simulation
Remove Digital Humans from a simulation (unlink only); idempotent for missing links.
POST
/
v1
/
simulation
/
{simulation_id}
/
remove-digital-humans
Remove Digital Humans From Simulation
curl --request POST \
--url https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"digital_human_ids": [
123
]
}
'import requests
url = "https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans"
payload = { "digital_human_ids": [123] }
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({digital_human_ids: [123]})
};
fetch('https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans', 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/simulation/{simulation_id}/remove-digital-humans",
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([
'digital_human_ids' => [
123
]
]),
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/simulation/{simulation_id}/remove-digital-humans"
payload := strings.NewReader("{\n \"digital_human_ids\": [\n 123\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/simulation/{simulation_id}/remove-digital-humans")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"digital_human_ids\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans")
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 \"digital_human_ids\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"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.
## Remove Digital Humans from Simulation — POST /v1/simulation/{simulation_id}/remove-digital-humans
> **What this endpoint does:** remove Digital Humans from a simulation (unlink only); idempotent for missing links.
**Endpoint:** POST `https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans`
**Auth:** `X-API-Key` header
**Content-Type:** application/json
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| simulation_id | integer | |
| X-API-Key | string | API key required to authenticate requests. |
| digital_human_ids | array[integer] | array of Digital Human IDs to remove from this simulation |
### Request Body (required fields)
```json
{
"digital_human_ids": [
123
]
}
```
Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/remove-digital-humans-from-simulation and send only schema-defined fields.
### Example
**POST with body:**
```python
import requests
def remove_digital_humans_from_simulation(simulation_id: int, payload: dict, api_key: str) -> dict:
url = f"https://api.getbluejay.ai/v1/simulation/{simulation_id}/remove-digital-humans"
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.
Path Parameters
Body
application/json
request body for removing digital humans from a simulation (unlink only).
array of digital human IDs to remove from this simulation
Response
Successful Response
response body for removing digital humans from a simulation (does not delete the digital humans).
success message