Send Http Text Message
curl --request POST \
--url https://api.getbluejay.ai/v1/send-http-text-message \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"simulation_result_id": "<string>",
"message": "<string>",
"end_conversation": false,
"end_turn": true,
"message_id": "<string>",
"type": "message"
}
'import requests
url = "https://api.getbluejay.ai/v1/send-http-text-message"
payload = {
"simulation_result_id": "<string>",
"message": "<string>",
"end_conversation": False,
"end_turn": True,
"message_id": "<string>",
"type": "message"
}
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({
simulation_result_id: '<string>',
message: '<string>',
end_conversation: false,
end_turn: true,
message_id: '<string>',
type: 'message'
})
};
fetch('https://api.getbluejay.ai/v1/send-http-text-message', 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/send-http-text-message",
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([
'simulation_result_id' => '<string>',
'message' => '<string>',
'end_conversation' => false,
'end_turn' => true,
'message_id' => '<string>',
'type' => 'message'
]),
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/send-http-text-message"
payload := strings.NewReader("{\n \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\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/send-http-text-message")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/send-http-text-message")
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 \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\n}"
response = http.request(request)
puts response.read_body{
"simulation_result_id": "<string>",
"status": "success",
"end_conversation": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Text/Chat Simulations
Send HTTP Text Message
Receive a text message via HTTP, process it through the lambda, and send response to webhook.
POST
/
v1
/
send-http-text-message
Send Http Text Message
curl --request POST \
--url https://api.getbluejay.ai/v1/send-http-text-message \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"simulation_result_id": "<string>",
"message": "<string>",
"end_conversation": false,
"end_turn": true,
"message_id": "<string>",
"type": "message"
}
'import requests
url = "https://api.getbluejay.ai/v1/send-http-text-message"
payload = {
"simulation_result_id": "<string>",
"message": "<string>",
"end_conversation": False,
"end_turn": True,
"message_id": "<string>",
"type": "message"
}
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({
simulation_result_id: '<string>',
message: '<string>',
end_conversation: false,
end_turn: true,
message_id: '<string>',
type: 'message'
})
};
fetch('https://api.getbluejay.ai/v1/send-http-text-message', 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/send-http-text-message",
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([
'simulation_result_id' => '<string>',
'message' => '<string>',
'end_conversation' => false,
'end_turn' => true,
'message_id' => '<string>',
'type' => 'message'
]),
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/send-http-text-message"
payload := strings.NewReader("{\n \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\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/send-http-text-message")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/send-http-text-message")
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 \"simulation_result_id\": \"<string>\",\n \"message\": \"<string>\",\n \"end_conversation\": false,\n \"end_turn\": true,\n \"message_id\": \"<string>\",\n \"type\": \"message\"\n}"
response = http.request(request)
puts response.read_body{
"simulation_result_id": "<string>",
"status": "success",
"end_conversation": false
}{
"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.
## Send HTTP Text Message — POST /v1/send-http-text-message
> **What this endpoint does:** Receive a text message via HTTP, process it through the lambda, and send response to webhook. Uses simulation_result_id (test_result_id) for Redis operations and evaluations.
**Endpoint:** POST `https://api.getbluejay.ai/v1/send-http-text-message`
**Auth:** `X-API-Key` header
**Content-Type:** application/json
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| simulation_result_id | string | ID of the simulation result (test result) |
| message | string | Text message to send (required when `type="message"`) |
| name | string | Tool name (required when `type="tool_call"`) |
### Optional Parameters
| Name | Type | Default | Description |
|------|------|---------|-------------|
| type | string | `"message"` | `"message"` for a conversation turn; `"tool_call"` to log a tool invocation without affecting the transcript |
| parameters | object | null | Tool input parameters (used when `type="tool_call"`) |
| output | any | null | Tool return value (used when `type="tool_call"`) |
| end_conversation | boolean | false | End and evaluate the conversation |
| end_turn | boolean | true | Process immediately (true) or stack for batching (false) |
| message_id | string | null | Deduplication key |
Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/send-http-text-message and include any optional parameters that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.
### Request Body examples
```json
// Regular message turn
{
"simulation_result_id": "string",
"message": "string"
}
// Tool call log (does not affect transcript or trigger agent response)
{
"simulation_result_id": "string",
"type": "tool_call",
"name": "tool_name",
"parameters": {},
"output": {}
}
```
Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/send-http-text-message. Include optional fields that serve the goal of setting up for testing and monitoring on Bluejay.
### Example
**POST with body:**
```python
import requests
def send_http_text_message(payload: dict, api_key: str) -> dict:
url = "https://api.getbluejay.ai/v1/send-http-text-message"
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.
Body
application/json
- HttpTextAgentUserMessageRequest
- HttpTextAgentToolCallRequest
Chat message: Send a message to the user.
ID of the simulation result (test result)
Text message to send
If true, skip lambda and end/evaluate the conversation
If true, process the message now; if false, stack it for later
Unique message ID for deduping within a conversation
Send a message to the user
Allowed value:
"message"