Invoke agent
curl --request POST \
--url https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data '
{
"message": "I need help setting up my account",
"release": "production"
}
'import requests
url = "https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke"
payload = {
"message": "I need help setting up my account",
"release": "production"
}
headers = {
"X-Maitai-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-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: 'I need help setting up my account', release: 'production'})
};
fetch('https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke', 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.trymaitai.ai/api/v1/agents/{agent_id}/invoke",
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([
'message' => 'I need help setting up my account',
'release' => 'production'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Maitai-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://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke"
payload := strings.NewReader("{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Maitai-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://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "chatcmpl-abc123",
"choices": [
{
"message": {
"role": "assistant",
"content": "Sure, let's start with your business details."
}
}
]
}
}Agents
Invoke agent
Run an agent and wait for its final response. Targets the draft by default; pass `version` (e.g. "1.2.0") or `release` (e.g. "production") to pin. Body: `{message}` or `{messages: [...]}`, plus optional `session_id`, `max_iterations`, and `secrets` ({NAME: value} for actions that declare `{{secrets.NAME}}` placeholders). Set `wait=false` to enqueue asynchronously and poll with the task endpoint instead.
POST
/
agents
/
{agent_id}
/
invoke
Invoke agent
curl --request POST \
--url https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data '
{
"message": "I need help setting up my account",
"release": "production"
}
'import requests
url = "https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke"
payload = {
"message": "I need help setting up my account",
"release": "production"
}
headers = {
"X-Maitai-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-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: 'I need help setting up my account', release: 'production'})
};
fetch('https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke', 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.trymaitai.ai/api/v1/agents/{agent_id}/invoke",
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([
'message' => 'I need help setting up my account',
'release' => 'production'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Maitai-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://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke"
payload := strings.NewReader("{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Maitai-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://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/agents/{agent_id}/invoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"I need help setting up my account\",\n \"release\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "chatcmpl-abc123",
"choices": [
{
"message": {
"role": "assistant",
"content": "Sure, let's start with your business details."
}
}
]
}
}Authorizations
Your Maitai API key from the Portal.
Path Parameters
Body
application/json
Shorthand for a single user message.
OpenAI-style message list (overrides message).
Pin a published version, e.g. '1.2.0'.
Pin a named release, e.g. 'production'.
Continue an existing agent session.
Structured output for the agent's final response. OpenAI-style: {"type": "json_object"} or {"type": "json_schema", "json_schema": {"name": ..., "schema": {...}}}. Omit for freeform text (default).
false = enqueue and return task ids immediately.
{NAME: value} map for actions that declare {{secrets.NAME}} placeholders in auth/headers. Ephemeral, never persisted.
Response
200 - application/json
Invoke agent.
Was this page helpful?