Create agent plan

curl --request POST \
  --url https://beta.getsales.io/unibox/v1/api/agent-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "conversation_sid": "<string>",
  "goal": "<string>",
  "run_sid": "<string>",
  "steps": [
    {
      "params": {}
    }
  ],
  "behavior_version": 2,
  "custom_scenario_sid": "<string>"
}
'

import requests

url = "https://beta.getsales.io/unibox/v1/api/agent-plans"

payload = {
    "conversation_sid": "<string>",
    "goal": "<string>",
    "run_sid": "<string>",
    "steps": [{ "params": {} }],
    "behavior_version": 2,
    "custom_scenario_sid": "<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({
    conversation_sid: '<string>',
    goal: '<string>',
    run_sid: '<string>',
    steps: [{params: {}}],
    behavior_version: 2,
    custom_scenario_sid: '<string>'
  })
};

fetch('https://beta.getsales.io/unibox/v1/api/agent-plans', 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-plans",
  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([
    'conversation_sid' => '<string>',
    'goal' => '<string>',
    'run_sid' => '<string>',
    'steps' => [
        [
                'params' => [
                                
                ]
        ]
    ],
    'behavior_version' => 2,
    'custom_scenario_sid' => '<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-plans"

	payload := strings.NewReader("{\n  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\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-plans")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/unibox/v1/api/agent-plans")

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  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "agent_sid": "<string>",
    "conversation_sid": "<string>",
    "state": "proposed",
    "goal": "<string>",
    "steps": [
      {
        "id": 2,
        "kind": "send_message",
        "params": {},
        "state": "pending",
        "executed_at": "<string>",
        "cause": "<string>"
      }
    ],
    "created_by_run_sid": "<string>",
    "behavior": "answer_interested",
    "behavior_version": 2,
    "custom_scenario_sid": "<string>",
    "approved_by_user_sid": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "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_plans

Create agent plan

Commit the plan a strategize run produced for one thread: steps [] in order, 1..8, a message step’s params carrying its text, each kind’s payload in the params describe. ACCESS: the agent-extended toolset only; a user or public token is 403 forbidden (agent_toolset_only); a human approves or edits one with update_agent_plan.

It supersedes the plan the thread held and points the thread at this one, in one transaction; the agent’s unsent messages there are withdrawn (the plan carries its own). Ids and step states are server-assigned. The requested state is a ceiling: under copilot the plan lands proposed, every step parked for approval. A run commits one plan: a second create by the same run answers 200 already_exists with the plan it made. A turn whose run no longer stands commits nothing (the lead wrote again, or the run was settled): 409 plan_turn_superseded, end the turn.

Steps are frozen here, texts included: each executes with no further LLM call, and a send_message step sends its text as written through the send door under the plan’s approval (422 rule required without one). Write the reply; when a reply is expected end with a wait_for_reply, the follow-up with its own text, and a last wait_for_reply. A stage move sets the linked person to the outcome stage the step names; a people search starts a credit-billed search at that person’s company; on a thread linked to no person both are skipped when due.

Contract:

MCP tool create_agent_plan, registry package mcp.unibox/agent_plans, mount unibox.agent.
Operation create, response envelope create.
Flags: none.

POST

api

agent-plans

Create agent plan

curl --request POST \
  --url https://beta.getsales.io/unibox/v1/api/agent-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "conversation_sid": "<string>",
  "goal": "<string>",
  "run_sid": "<string>",
  "steps": [
    {
      "params": {}
    }
  ],
  "behavior_version": 2,
  "custom_scenario_sid": "<string>"
}
'

import requests

url = "https://beta.getsales.io/unibox/v1/api/agent-plans"

payload = {
    "conversation_sid": "<string>",
    "goal": "<string>",
    "run_sid": "<string>",
    "steps": [{ "params": {} }],
    "behavior_version": 2,
    "custom_scenario_sid": "<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({
    conversation_sid: '<string>',
    goal: '<string>',
    run_sid: '<string>',
    steps: [{params: {}}],
    behavior_version: 2,
    custom_scenario_sid: '<string>'
  })
};

fetch('https://beta.getsales.io/unibox/v1/api/agent-plans', 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-plans",
  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([
    'conversation_sid' => '<string>',
    'goal' => '<string>',
    'run_sid' => '<string>',
    'steps' => [
        [
                'params' => [
                                
                ]
        ]
    ],
    'behavior_version' => 2,
    'custom_scenario_sid' => '<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-plans"

	payload := strings.NewReader("{\n  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\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-plans")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/unibox/v1/api/agent-plans")

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  \"conversation_sid\": \"<string>\",\n  \"goal\": \"<string>\",\n  \"run_sid\": \"<string>\",\n  \"steps\": [\n    {\n      \"params\": {}\n    }\n  ],\n  \"behavior_version\": 2,\n  \"custom_scenario_sid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "agent_sid": "<string>",
    "conversation_sid": "<string>",
    "state": "proposed",
    "goal": "<string>",
    "steps": [
      {
        "id": 2,
        "kind": "send_message",
        "params": {},
        "state": "pending",
        "executed_at": "<string>",
        "cause": "<string>"
      }
    ],
    "created_by_run_sid": "<string>",
    "behavior": "answer_interested",
    "behavior_version": 2,
    "custom_scenario_sid": "<string>",
    "approved_by_user_sid": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "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

Authorization

string

header

required

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-SID

string

header

required

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_plan.

conversation_sid

string

required

The thread being planned for. Its previous live plan is superseded in the same transaction and conversations.active_plan_sid is re-pointed here.

Required string length: 18

Pattern: ^ub_cv_

goal

string

required

The plan's intent in one human-readable line, 1..255 chars. It is what the thread and the context panel render.

Required string length: 1 - 255

run_sid

string

required

The strategize run committing this plan (ub_rn_…). It is the audit anchor: the plan is later explained through this run.

Required string length: 18

Pattern: ^ub_rn_

steps

object[]

required

The ordered steps, 1 to 8. Ids and step states are assigned server-side; a plan born proposed parks every step as awaiting_approval.

Required array length: 1 - 8 elements

Show child attributes

state

enum<string>

Default proposed. The mode gate is server-side, so a plan asked for as active under copilot is still parked for approval, and a post-goal plan, or one that carries a reach_objective step, is floored to proposed whatever is sent.

Available options:

proposed,

active

behavior

enum<string> | null

The built-in competence module that planned; null when a matched custom scenario drove the plan on its own.

Available options:

answer_interested,

meeting_request_book,

answer_info_request,

referral_capture,

not_now_defer,

ooo_delay_ping,

auto_reply_skip,

wrong_person_referral,

reschedule_meeting,

cancel_meeting,

return_to_orchestration,

close_not_interested,

handle_objection,

stoplist_do_not_contact,

vendor_pitch_skip,

acknowledge_low_signal,

followup_no_reply,

signal_followup,

followup_after_person

behavior_version

integer | null

Version of that module, taken from its manifest. Stamped for audit, never interpreted.

Required range: x >= 1

custom_scenario_sid

string | null

The custom scenario (ub_sc_…) that matched this reply, when one did.

Required string length: 18

Pattern: ^ub_sc_

Response

create success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

create

item

object

required

Show child attributes

already_exists

boolean

required

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Create agent plan

Authorizations

Body

Response