Chat with mailbox agent
curl --request POST \
--url https://console.mermail.app/api/agent/mailbox \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mailboxId": "[email protected]",
"conversationId": "conv_01",
"messages": [
{
"id": "u1",
"role": "user",
"parts": [
{
"type": "text",
"text": "What needs a reply?"
}
]
}
]
}
'import requests
url = "https://console.mermail.app/api/agent/mailbox"
payload = {
"mailboxId": "[email protected]",
"conversationId": "conv_01",
"messages": [
{
"id": "u1",
"role": "user",
"parts": [
{
"type": "text",
"text": "What needs a reply?"
}
]
}
]
}
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mailboxId: '[email protected]',
conversationId: 'conv_01',
messages: [{id: 'u1', role: 'user', parts: [{type: 'text', text: 'What needs a reply?'}]}]
})
};
fetch('https://console.mermail.app/api/agent/mailbox', 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://console.mermail.app/api/agent/mailbox",
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([
'mailboxId' => '[email protected]',
'conversationId' => 'conv_01',
'messages' => [
[
'id' => 'u1',
'role' => 'user',
'parts' => [
[
'type' => 'text',
'text' => 'What needs a reply?'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://console.mermail.app/api/agent/mailbox"
payload := strings.NewReader("{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://console.mermail.app/api/agent/mailbox")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/agent/mailbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body"(streaming AI SDK UI message response)"{
"error": "Invalid request"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Conflict"
}{
"error": "Too many requests"
}AI agent
Chat with mailbox agent
Plans: Free · Developer · Enterprise
Streams an AI agent chat turn for a mailbox conversation. Response is an AI SDK UI message stream (not a plain JSON object). The latest message must be from the user. Duplicate message ids return 409.
API credits: 25 (ai_heavy).
POST
https://console.mermail.app
/
api
/
agent
/
mailbox
Chat with mailbox agent
curl --request POST \
--url https://console.mermail.app/api/agent/mailbox \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mailboxId": "[email protected]",
"conversationId": "conv_01",
"messages": [
{
"id": "u1",
"role": "user",
"parts": [
{
"type": "text",
"text": "What needs a reply?"
}
]
}
]
}
'import requests
url = "https://console.mermail.app/api/agent/mailbox"
payload = {
"mailboxId": "[email protected]",
"conversationId": "conv_01",
"messages": [
{
"id": "u1",
"role": "user",
"parts": [
{
"type": "text",
"text": "What needs a reply?"
}
]
}
]
}
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mailboxId: '[email protected]',
conversationId: 'conv_01',
messages: [{id: 'u1', role: 'user', parts: [{type: 'text', text: 'What needs a reply?'}]}]
})
};
fetch('https://console.mermail.app/api/agent/mailbox', 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://console.mermail.app/api/agent/mailbox",
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([
'mailboxId' => '[email protected]',
'conversationId' => 'conv_01',
'messages' => [
[
'id' => 'u1',
'role' => 'user',
'parts' => [
[
'type' => 'text',
'text' => 'What needs a reply?'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://console.mermail.app/api/agent/mailbox"
payload := strings.NewReader("{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://console.mermail.app/api/agent/mailbox")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/agent/mailbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mailboxId\": \"[email protected]\",\n \"conversationId\": \"conv_01\",\n \"messages\": [\n {\n \"id\": \"u1\",\n \"role\": \"user\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"What needs a reply?\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body"(streaming AI SDK UI message response)"{
"error": "Invalid request"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Conflict"
}{
"error": "Too many requests"
}Authorizations
API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.
Body
application/json
Response
UI message stream
The response is of type string.
⌘I