Run network

curl --request POST \
  --url https://api.sidenet.ai/v1/copilots/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "user",
      "parts": [
        {
          "type": "text",
          "text": "Where is my order?"
        }
      ]
    }
  ],
  "approval": {
    "runId": "run_6d20a95c",
    "toolCallId": "call_a17f3b",
    "approved": true
  },
  "threadId": "thread_2f81c04a",
  "context": [
    "The customer is on the enterprise plan."
  ],
  "variables": {
    "locale": "English",
    "instance": {
      "store_count": 12
    }
  },
  "tools": {
    "Acme_CRM_get_customer": {
      "enabled": true
    }
  },
  "metadata": {
    "source": "web-widget"
  },
  "use_routing": true,
  "suggest_followups": true
}
'

import requests

url = "https://api.sidenet.ai/v1/copilots/{id}/run"

payload = {
    "messages": [
        {
            "role": "user",
            "parts": [
                {
                    "type": "text",
                    "text": "Where is my order?"
                }
            ]
        }
    ],
    "approval": {
        "runId": "run_6d20a95c",
        "toolCallId": "call_a17f3b",
        "approved": True
    },
    "threadId": "thread_2f81c04a",
    "context": ["The customer is on the enterprise plan."],
    "variables": {
        "locale": "English",
        "instance": { "store_count": 12 }
    },
    "tools": { "Acme_CRM_get_customer": { "enabled": True } },
    "metadata": { "source": "web-widget" },
    "use_routing": True,
    "suggest_followups": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{role: 'user', parts: [{type: 'text', text: 'Where is my order?'}]}],
    approval: {runId: 'run_6d20a95c', toolCallId: 'call_a17f3b', approved: true},
    threadId: 'thread_2f81c04a',
    context: ['The customer is on the enterprise plan.'],
    variables: {locale: 'English', instance: {store_count: 12}},
    tools: {Acme_CRM_get_customer: {enabled: true}},
    metadata: {source: 'web-widget'},
    use_routing: true,
    suggest_followups: true
  })
};

fetch('https://api.sidenet.ai/v1/copilots/{id}/run', 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.sidenet.ai/v1/copilots/{id}/run",
  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([
    'messages' => [
        [
                'role' => 'user',
                'parts' => [
                                [
                                                                'type' => 'text',
                                                                'text' => 'Where is my order?'
                                ]
                ]
        ]
    ],
    'approval' => [
        'runId' => 'run_6d20a95c',
        'toolCallId' => 'call_a17f3b',
        'approved' => true
    ],
    'threadId' => 'thread_2f81c04a',
    'context' => [
        'The customer is on the enterprise plan.'
    ],
    'variables' => [
        'locale' => 'English',
        'instance' => [
                'store_count' => 12
        ]
    ],
    'tools' => [
        'Acme_CRM_get_customer' => [
                'enabled' => true
        ]
    ],
    'metadata' => [
        'source' => 'web-widget'
    ],
    'use_routing' => true,
    'suggest_followups' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.sidenet.ai/v1/copilots/{id}/run"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.sidenet.ai/v1/copilots/{id}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sidenet.ai/v1/copilots/{id}/run")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}"

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

{
  "threadId": "<string>",
  "requestId": "<string>",
  "text": "<string>",
  "reasoning": "<string>",
  "toolCalls": [
    {
      "toolCallId": "<string>",
      "toolName": "<string>",
      "input": {},
      "output": {},
      "error": "<string>"
    }
  ],
  "data": [
    {
      "type": "<string>",
      "data": {}
    }
  ],
  "errors": [
    "<string>"
  ],
  "finishReason": "<string>"
}

Chat & Messaging

Run network

Runs the network against messages. When the network has more than one agent, routing picks which one answers (send use_routing: false to take the default agent instead); the data-handoff entry in data says which one it was. Returns the finished turn as JSON: text is the answer, toolCalls what the agent called on the way, data the custom parts. This is the same run POST /v1/chat performs — same routing, memory, tools, usage accounting and cost — with the stream collected server-side, so it responds only when the turn is complete and takes as long as the turn takes. Use /v1/chat when you want tokens as they are generated. Pass the returned threadId back to continue the conversation.

POST

copilots

{id}

run

Run network

curl --request POST \
  --url https://api.sidenet.ai/v1/copilots/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "user",
      "parts": [
        {
          "type": "text",
          "text": "Where is my order?"
        }
      ]
    }
  ],
  "approval": {
    "runId": "run_6d20a95c",
    "toolCallId": "call_a17f3b",
    "approved": true
  },
  "threadId": "thread_2f81c04a",
  "context": [
    "The customer is on the enterprise plan."
  ],
  "variables": {
    "locale": "English",
    "instance": {
      "store_count": 12
    }
  },
  "tools": {
    "Acme_CRM_get_customer": {
      "enabled": true
    }
  },
  "metadata": {
    "source": "web-widget"
  },
  "use_routing": true,
  "suggest_followups": true
}
'

import requests

url = "https://api.sidenet.ai/v1/copilots/{id}/run"

payload = {
    "messages": [
        {
            "role": "user",
            "parts": [
                {
                    "type": "text",
                    "text": "Where is my order?"
                }
            ]
        }
    ],
    "approval": {
        "runId": "run_6d20a95c",
        "toolCallId": "call_a17f3b",
        "approved": True
    },
    "threadId": "thread_2f81c04a",
    "context": ["The customer is on the enterprise plan."],
    "variables": {
        "locale": "English",
        "instance": { "store_count": 12 }
    },
    "tools": { "Acme_CRM_get_customer": { "enabled": True } },
    "metadata": { "source": "web-widget" },
    "use_routing": True,
    "suggest_followups": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{role: 'user', parts: [{type: 'text', text: 'Where is my order?'}]}],
    approval: {runId: 'run_6d20a95c', toolCallId: 'call_a17f3b', approved: true},
    threadId: 'thread_2f81c04a',
    context: ['The customer is on the enterprise plan.'],
    variables: {locale: 'English', instance: {store_count: 12}},
    tools: {Acme_CRM_get_customer: {enabled: true}},
    metadata: {source: 'web-widget'},
    use_routing: true,
    suggest_followups: true
  })
};

fetch('https://api.sidenet.ai/v1/copilots/{id}/run', 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.sidenet.ai/v1/copilots/{id}/run",
  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([
    'messages' => [
        [
                'role' => 'user',
                'parts' => [
                                [
                                                                'type' => 'text',
                                                                'text' => 'Where is my order?'
                                ]
                ]
        ]
    ],
    'approval' => [
        'runId' => 'run_6d20a95c',
        'toolCallId' => 'call_a17f3b',
        'approved' => true
    ],
    'threadId' => 'thread_2f81c04a',
    'context' => [
        'The customer is on the enterprise plan.'
    ],
    'variables' => [
        'locale' => 'English',
        'instance' => [
                'store_count' => 12
        ]
    ],
    'tools' => [
        'Acme_CRM_get_customer' => [
                'enabled' => true
        ]
    ],
    'metadata' => [
        'source' => 'web-widget'
    ],
    'use_routing' => true,
    'suggest_followups' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.sidenet.ai/v1/copilots/{id}/run"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.sidenet.ai/v1/copilots/{id}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sidenet.ai/v1/copilots/{id}/run")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"parts\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"Where is my order?\"\n        }\n      ]\n    }\n  ],\n  \"approval\": {\n    \"runId\": \"run_6d20a95c\",\n    \"toolCallId\": \"call_a17f3b\",\n    \"approved\": true\n  },\n  \"threadId\": \"thread_2f81c04a\",\n  \"context\": [\n    \"The customer is on the enterprise plan.\"\n  ],\n  \"variables\": {\n    \"locale\": \"English\",\n    \"instance\": {\n      \"store_count\": 12\n    }\n  },\n  \"tools\": {\n    \"Acme_CRM_get_customer\": {\n      \"enabled\": true\n    }\n  },\n  \"metadata\": {\n    \"source\": \"web-widget\"\n  },\n  \"use_routing\": true,\n  \"suggest_followups\": true\n}"

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

{
  "threadId": "<string>",
  "requestId": "<string>",
  "text": "<string>",
  "reasoning": "<string>",
  "toolCalls": [
    {
      "toolCallId": "<string>",
      "toolName": "<string>",
      "input": {},
      "output": {},
      "error": "<string>"
    }
  ],
  "data": [
    {
      "type": "<string>",
      "data": {}
    }
  ],
  "errors": [
    "<string>"
  ],
  "finishReason": "<string>"
}

Authorizations

Authorization

string

header

required

Session token (snat_…) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.

Path Parameters

string

required

Network (copilot) id.

Example:

"a5e91c07-3f24-4b68-9d15-8c72e0b4a396"

Body

application/json

messages

array

The conversation, in AI SDK UIMessage format: [{ "role": "user", "parts": [{ "type": "text", "text": "..." }] }]. Send the whole exchange you want the agent to see; with a threadId the stored history is loaded too, so the new turn is usually the only entry. May be empty only on an approval continuation.

Example:

[
  {
    "role": "user",
    "parts": [
      {
        "type": "text",
        "text": "Where is my order?"
      }
    ]
  }
]

approval

object

Approve or decline a tool call that paused the previous stream

Show child attributes

Example:

{
  "runId": "run_6d20a95c",
  "toolCallId": "call_a17f3b",
  "approved": true
}

threadId

string

Conversation thread id

Example:

"thread_2f81c04a"

context

string[]

Additional context messages to provide to the agent.

Example:

["The customer is on the enterprise plan."]

variables

object

Values for {{variable}} placeholders in the agent's prompt blocks. Scalars (string, number, boolean) or arrays of them. A dot path up to 3 segments may be sent nested or as a dotted key — { "user": { "language": "FR" } } and { "user.language": "FR" } both fill {{user.language}}. This is the shape GET /v1/copilots/{id} and GET /v1/agents/{id} return under variables: fill in the leaves you have and send the object back. A null leaf is ignored (the placeholder falls back to its own default), so leaving one unfilled is the same as omitting it. Display-only — never used for authorization or identity. Reserved: now.*. Entries with an unsupported key or value are dropped, not rejected: a display-only field must not fail a chat turn.

Show child attributes

Example:

{
  "locale": "English",
  "instance": { "store_count": 12 }
}

trigger

enum<string>

AI SDK trigger type

Available options:

submit-message,

regenerate-message

tools

object

AI SDK client-side tools

Show child attributes

Example:

{
  "Acme_CRM_get_customer": { "enabled": true }
}

metadata

object

AI SDK session metadata

Show child attributes

Example:

{ "source": "web-widget" }

use_routing

boolean

default:true

Default true. When the request targets an orchestrator agent, routing picks whether to stream the orchestrator (multi-step / synthesis) or a single subagent directly (domain-specific ask). No effect when the resolved agent is not an orchestrator. Pass false to disable.

suggest_followups

boolean

default:true

Default true. After the answer finishes streaming, a small model proposes up to 3 questions the user could ask next, emitted as a data-followups chunk for the client to render as chips. Costs one extra model call per turn and holds the stream open slightly longer — pass false to disable. Only applies to copilotId requests: an agentId run has no UI to render chips into, so suggestions never run there.

Response

The finished turn

threadId

string

The conversation this turn belongs to — the one you sent, or the one created for you. Send it back on the next call to continue.

requestId

string | null

Correlation id for this run; the join key for its traces and cost.

text

string

The agent's answer.

reasoning

string

Reasoning text, when the model emitted any. Absent otherwise.

toolCalls

object[]

The tools the agent called, in order, each with its input and either its output or the error it failed with.

Show child attributes

data

object[]

Custom parts the run emitted: data-handoff (which agent a network routed to), data-tool-workflow (workflow step progress), and data-tool-call-approval — that last one means the run PAUSED for human approval rather than finishing. Call again with approval and the same threadId to continue it.

Show child attributes

errors

string[]

Errors the run reported. A turn can fail after it began answering, so this can be non-empty alongside text — and the status is still 200, because the same failure over /v1/chat happens long after the headers.

finishReason

string

Authentication

Users & Groups

Chat & Messaging

Agents

Prompt Blocks

Workflows

Workflow Schedules

Networks

Tools

Tool Providers

Scoring & Experiments

System

Run network

Authorizations

Path Parameters

Body

Response