Protocol v2 Command

Send a single protocol command scoped to a thread. The request body is a ProtocolCommand envelope with a method (e.g. run.start, input.respond, agent.getTree) and method-specific params. The response is either a ProtocolSuccess (with method-specific result) or a ProtocolError.

Commands that create runs (run.start, input.respond) leave the run executing in the background on the worker queue. Event streaming for that run is observed via a concurrent POST /threads/{thread_id}/stream/events connection.

WebSocket clients use the same command envelope in-band on /threads/{thread_id}/stream/events and additionally have access to subscription.subscribe / subscription.unsubscribe over the same connection.

POST /threads/{thread_id}/commands

Protocol v2 Command

cURL

curl --request POST \
  --url https://api.example.com/threads/{thread_id}/commands \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "method": "<string>",
  "params": {}
}
'

import requests

url = "https://api.example.com/threads/{thread_id}/commands"

payload = {
    "id": 1,
    "method": "<string>",
    "params": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({id: 1, method: '<string>', params: {}})
};

fetch('https://api.example.com/threads/{thread_id}/commands', 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.example.com/threads/{thread_id}/commands",
  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([
    'id' => 1,
    'method' => '<string>',
    'params' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/threads/{thread_id}/commands"

	payload := strings.NewReader("{\n  \"id\": 1,\n  \"method\": \"<string>\",\n  \"params\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.example.com/threads/{thread_id}/commands")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 1,\n  \"method\": \"<string>\",\n  \"params\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/threads/{thread_id}/commands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 1,\n  \"method\": \"<string>\",\n  \"params\": {}\n}"

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

200

{
  "type": "<string>",
  "id": 1,
  "result": {},
  "meta": {
    "applied_through_seq": 1
  }
}

{
  "type": "<string>",
  "id": 1,
  "message": "<string>",
  "stacktrace": "<string>",
  "meta": {
    "applied_through_seq": 1
  }
}

Path Parameters

thread_id · string<uuid> · required

The ID of the thread the command applies to.

Body

application/json

A client → server command envelope. Known methods: run.start, input.respond, subscription.subscribe (WS only), subscription.unsubscribe (WS only), agent.getTree.

id · integer · required

Client-assigned command id; echoed in the response.

Required range: x >= 0

method · string · required

Command method name (e.g. run.start).

params · object

Method-specific parameters. See the CDDL spec for per-method shapes.

Response

200

application/json

Protocol response — either ProtocolSuccess or ProtocolError.

ProtocolSuccess

ProtocolError

Successful command response.

type · string · required

Allowed value: "success"

id · integer · required

Required range: x >= 0

result · object · required

Method-specific result payload.

meta · ProtocolResponseMeta · object

Optional metadata attached to command responses.

Show child attributes