Create agent scenario
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"title": "<string>",
"trigger": "<string>",
"agent_sid": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [
{
"when": "<string>"
}
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios"
payload = {
"title": "<string>",
"trigger": "<string>",
"agent_sid": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": True,
"locked": True,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [{ "when": "<string>" }]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: '<string>',
trigger: '<string>',
agent_sid: '<string>',
context: '<string>',
steps: [
{
id: '<string>',
enabled: true,
locked: true,
when: '<string>',
instructions: '<string>',
params: {}
}
],
conditions: [{when: '<string>'}]
})
};
fetch('https://beta.getsales.io/unibox/v1/api/agent-scenarios', 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://beta.getsales.io/unibox/v1/api/agent-scenarios",
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([
'title' => '<string>',
'trigger' => '<string>',
'agent_sid' => '<string>',
'context' => '<string>',
'steps' => [
[
'id' => '<string>',
'enabled' => true,
'locked' => true,
'when' => '<string>',
'instructions' => '<string>',
'params' => [
]
]
],
'conditions' => [
[
'when' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/unibox/v1/api/agent-scenarios"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/unibox/v1/api/agent-scenarios")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}agent_scenarios
Create agent scenario
Add a scenario of the team’s own: when the trigger text matches an incoming reply the agent follows this scenario (its own steps when it has them, else the classified scenario’s playbook with the context over it). Takes effect from the next classify run; at most 20 of the team’s own that are not Off. Born autopilot unless level says otherwise. A platform scenario is never created: edit it by key with update_agent_scenario.
Contract:
- MCP tool
create_agent_scenario, registry packagemcp.unibox/agent_scenarios, mountunibox.agent. - Operation
create, response envelopecreate. - Flags: none.
POST
/
api
/
agent-scenarios
Create agent scenario
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"title": "<string>",
"trigger": "<string>",
"agent_sid": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [
{
"when": "<string>"
}
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios"
payload = {
"title": "<string>",
"trigger": "<string>",
"agent_sid": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": True,
"locked": True,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [{ "when": "<string>" }]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: '<string>',
trigger: '<string>',
agent_sid: '<string>',
context: '<string>',
steps: [
{
id: '<string>',
enabled: true,
locked: true,
when: '<string>',
instructions: '<string>',
params: {}
}
],
conditions: [{when: '<string>'}]
})
};
fetch('https://beta.getsales.io/unibox/v1/api/agent-scenarios', 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://beta.getsales.io/unibox/v1/api/agent-scenarios",
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([
'title' => '<string>',
'trigger' => '<string>',
'agent_sid' => '<string>',
'context' => '<string>',
'steps' => [
[
'id' => '<string>',
'enabled' => true,
'locked' => true,
'when' => '<string>',
'instructions' => '<string>',
'params' => [
]
]
],
'conditions' => [
[
'when' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/unibox/v1/api/agent-scenarios"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/unibox/v1/api/agent-scenarios")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"agent_sid\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of create_agent_scenario.
The scenario's name, 1..255 chars, the natural key inside the team.
Required string length:
1 - 255When the scenario applies, in plain language, written for an LLM to match against one inbound reply.
Required string length:
1 - 2048The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.
Required string length:
18Pattern:
^ub_ag_The instructions over the playbook, any length; the compaction writes the copy the model reads after the save.
Maximum string length:
32768The scenario's own steps; omit them and the classified scenario's playbook applies with the context over it.
Maximum array length:
16Show child attributes
Show child attributes
Default autopilot. off drafts no reply (the other steps still run; a task step hands the thread over). The 21st own scenario is a 429 limit_exceeded.
Available options:
autopilot, copilot, conditional, off With level conditional: the conditions in order (at most 6), the first that holds deciding; a lead condition needs its words.
Maximum array length:
6Show child attributes
Show child attributes