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.
Session token (snat_…) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.
Path Parameters
id
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
Continue a tool call that paused the previous stream: approve/decline it, or answer a suspended tool with data
The environment this request runs in, recorded on its traces and usage. Defaults to the copilot's environment for routed requests, else dev.
Available options:
dev,
staging,
prod
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.
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.
mode
enum<string>
dashboard marks a conversation that lives in the Dashboards section (the new-dashboard view, or an open dashboard): the thread is stamped with the dashboard it is about (dashboardId) or, when it has none yet, with the dashboard the turn builds, so it becomes that dashboard's conversation. It changes nothing about who answers: the roster answers every turn and delegates dashboard work to the dashboard agent. Without it, a dashboard built from an ordinary conversation is not tied to that thread.
Available options:
dashboard
dashboardId
string<uuid>
The dashboard the user is looking at (/v1/dashboards). The agent that answers gets its current data in context — to answer questions about it and to brief the dashboard agent for a change — and the thread is stamped with it, so follow-ups need no id. Omit when the conversation is not about a dashboard.
delivery
object
For a caller that relays answers itself (a messaging channel). Names the tool that relays the result of a SCHEDULE created during this turn: the schedule copies it, and after each of its runs — succeeded or failed — the tool is called as the schedule's owner, with their stored tool credentials, with { ...input, [result_key]: { text, attachments, run_id, schedule_id, automation_name, status, error } }. This run itself does nothing with it: you relay its answer as usual. The agent never sees the field and cannot change it.
Show child attributes
automation_confirmation
enum<string>
default:card
How the user approves an automation the agent builds in this turn. card (default): the turn pauses on the workflow card (data-tool-call-suspended), which a chat UI shows with Test and Approve. text: for a channel that cannot show a card — the agent says in words what will be sent and when, the user replies yes in a later message (same threadId), and only then is the automation saved and scheduled. The turn never pauses.
Available options:
card,
text
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. When a step of the turn was redone (a data-step-redo part in data), only what the agent wrote after the redo: the text it withdrew is not part of the 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), data-tool-progress-message (the one-line progress message of a tool call, for a live UI), data-step-redo (the agent's reply was rejected by a platform check and written again; text holds the final one), 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
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sidenet API","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#4338CA"},"logo":{"light":"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-light.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=206c6acd674e00cc951ff99d54600daa","dark":"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=db3396c278572b71489a4c1be475acd4","href":"https://www.sidenet.ai"},"favicon":{"light":"https://mintcdn.com/sidenetai/bYiM267pd74qNSPc/images/3bc48416-a174-468b-9d1a-56046f8bb9b4.png?fit=max\u0026auto=format\u0026n=bYiM267pd74qNSPc\u0026q=85\u0026s=b651ac95041904f0eaf2678e8d2704ab","dark":"https://mintcdn.com/sidenetai/bYiM267pd74qNSPc/images/3bc48416-a174-468b-9d1a-56046f8bb9b4.png?fit=max\u0026auto=format\u0026n=bYiM267pd74qNSPc\u0026q=85\u0026s=b651ac95041904f0eaf2678e8d2704ab"},"api":{"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://www.sidenet.ai","label":"Back to website"},{"href":"https://www.sidenet.ai/book-demo/","label":"Book a demo"}],"primary":{"type":"button","label":"Sidenet Studio","href":"https://studio.sidenet.ai"}},"footer":{"socials":{"website":"https://www.sidenet.ai"}},"seo":{"metatags":{"canonical":"https://www.sidenet.ai"},"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sidenetai","hasAudioNarration":false,"actualSubdomain":"sidenetai","customDomains":["sidenet.ai"],"gitSource":{"type":"github","owner":"alexdanan","repo":"sidenet-api","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af9f11af1de041cd01487d6","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Guides","count":23},{"language":"default","tag":"Browser","count":17},{"language":"default","tag":"Chat SDK","count":13},{"language":"default","tag":"Chat \u0026 Messaging","count":12},{"language":"default","tag":"Workflow Schedules","count":12},{"language":"default","tag":"Dashboards","count":11},{"language":"default","tag":"Networks","count":11},{"language":"default","tag":"Prompt Blocks","count":11},{"language":"default","tag":"Workflows","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/chat/run-network","slug":"/api-reference/chat/run-network","pageMetadata":{"title":"Run network","description":"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.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/run","href":"/api-reference/chat/run-network","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Runs the network against \", _jsx(_components.code, {\n children: \"messages\"\n }), \". When the network has more than one agent, routing picks which one answers (send \", _jsx(_components.code, {\n children: \"use_routing: false\"\n }), \" to take the default agent instead); the \", _jsx(_components.code, {\n children: \"data-handoff\"\n }), \" entry in \", _jsx(_components.code, {\n children: \"data\"\n }), \" says which one it was. Returns the finished turn as JSON: \", _jsx(_components.code, {\n children: \"text\"\n }), \" is the answer, \", _jsx(_components.code, {\n children: \"toolCalls\"\n }), \" what the agent called on the way, \", _jsx(_components.code, {\n children: \"data\"\n }), \" 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 \", _jsx(_components.code, {\n children: \"threadId\"\n }), \" back to continue the conversation.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run network","description":"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.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/run","href":"/api-reference/chat/run-network","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/sidenetai/8e3ad2809aba5c1a/analytics.js"],"openApiReferenceData":{"operation":{"summary":"Run network","description":"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.","tags":["Chat"],"parameters":["da458aa0-5bcc-4c34-8f8d-50fa9f141d34"],"requestBody":"a211873c-8376-414d-8941-de98838723ed","responses":{"200":"4c2a921c-9add-47ac-9d7e-27e2ee2e080d","400":"cac2bd28-8158-49e6-b86d-5713834a9bbe","403":"ae5cd293-974f-41cb-9b7d-96292d48d330","404":"56bd8e17-ce37-4d42-8a33-766696daab5d","429":"faa6c81f-e434-47c2-9f50-73bed5936a72"},"security":["c9522795-f46b-45e9-a28e-1a91137ca6ef"],"method":"post","type":"path","servers":["5a9ef6cd-d896-47ca-98f0-fbb8d6f1aa96"],"path":"/v1/copilots/{id}/run","baseUrlOptions":["https://api.sidenet.ai"],"title":"Run network","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.messages":[{"role":"user","parts":[{"type":"text","text":"Where is my order?"}]}],"body.approval.runId":"run_6d20a95c","body.approval.toolCallId":"call_a17f3b","body.approval.approved":true,"body.threadId":"thread_2f81c04a","body.context.items.0":"The customer is on the enterprise plan.","body.variables.locale":"English","body.variables.instance":{"store_count":12},"body.tools.Acme_CRM_get_customer":{"enabled":true},"body.metadata.source":"web-widget","body.use_routing":true,"body.suggest_followups":true,"body.mode":"dashboard","body.dashboardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.automation_confirmation":"card"}]},"dependencies":{"parameters":{"da458aa0-5bcc-4c34-8f8d-50fa9f141d34":{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"a5e91c07-3f24-4b68-9d15-8c72e0b4a396","isRequired":true,"description":"Network (copilot) id.","uniqueKey":"","typeLabel":"string"},"description":"Network (copilot) id."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","default":[],"description":"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?"}]}],"uniqueKey":"messages","typeLabel":"array"},"approval":{"type":"object","properties":{"runId":{"type":"string","minLength":1,"description":"runId from the data-tool-call-approval / data-tool-call-suspended chunk","isRequired":true,"uniqueKey":"approval.runId","typeLabel":"string"},"toolCallId":{"type":"string","minLength":1,"description":"Disambiguates when multiple tool calls are pending; defaults to the most recent","uniqueKey":"approval.toolCallId","typeLabel":"string"},"approved":{"type":"boolean","description":"Approval pause: true = run the tool, false = decline it","uniqueKey":"approval.approved","typeLabel":"boolean"},"reason":{"type":"string","minLength":1,"maxLength":2000,"description":"Decline only: why the user said no. Persisted with the declined call and given to the model in place of the default \"not approved\" notice, so it can act on it (\"use the other card\") instead of just moving on","uniqueKey":"approval.reason","typeLabel":"string"},"data":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"approval.data.additionalProperties","typeLabel":"any"},"description":"Suspended tool: the resume data the tool asked for (its resumeSchema), e.g. the workflow card's { action, workflow_id, … }","uniqueKey":"approval.data","typeLabel":"object"}},"required":["runId"],"additionalProperties":false,"description":"Continue a tool call that paused the previous stream: approve/decline it, or answer a suspended tool with `data`","example":{"runId":"run_6d20a95c","toolCallId":"call_a17f3b","approved":true},"uniqueKey":"approval","typeLabel":"object"},"environment":{"type":"string","enum":["dev","staging","prod"],"description":"The environment this request runs in, recorded on its traces and usage. Defaults to the copilot's environment for routed requests, else `dev`.","uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"threadId":{"type":"string","description":"Conversation thread id","example":"thread_2f81c04a","uniqueKey":"threadId","typeLabel":"string"},"context":{"type":"array","items":{"type":"string","uniqueKey":"context.items.[INDEX]","typeLabel":"string"},"description":"Additional context messages to provide to the agent.","example":["The customer is on the enterprise plan."],"uniqueKey":"context","typeLabel":"string[]"},"variables":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"variables.additionalProperties","typeLabel":"any"},"description":"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.","example":{"locale":"English","instance":{"store_count":12}},"uniqueKey":"variables","typeLabel":"object"},"trigger":{"type":"string","enum":["submit-message","regenerate-message"],"description":"AI SDK trigger type","uniqueKey":"trigger","typeLabel":"enum\u003cstring>"},"tools":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"tools.additionalProperties","typeLabel":"any"},"description":"AI SDK client-side tools","example":{"Acme_CRM_get_customer":{"enabled":true}},"uniqueKey":"tools","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"description":"AI SDK session metadata","example":{"source":"web-widget"},"uniqueKey":"metadata","typeLabel":"object"},"use_routing":{"type":"boolean","default":true,"description":"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.","uniqueKey":"use_routing","typeLabel":"boolean"},"suggest_followups":{"type":"boolean","default":true,"description":"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.","uniqueKey":"suggest_followups","typeLabel":"boolean"},"mode":{"type":"string","enum":["dashboard"],"description":"`dashboard` marks a conversation that lives in the Dashboards section (the new-dashboard view, or an open dashboard): the thread is stamped with the dashboard it is about (`dashboardId`) or, when it has none yet, with the dashboard the turn builds, so it becomes that dashboard's conversation. It changes nothing about who answers: the roster answers every turn and delegates dashboard work to the dashboard agent. Without it, a dashboard built from an ordinary conversation is not tied to that thread.","uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"dashboardId":{"type":"string","format":"uuid","description":"The dashboard the user is looking at (`/v1/dashboards`). The agent that answers gets its current data in context — to answer questions about it and to brief the dashboard agent for a change — and the thread is stamped with it, so follow-ups need no id. Omit when the conversation is not about a dashboard.","uniqueKey":"dashboardId","typeLabel":"string\u003cuuid>"},"delivery":{"type":"object","description":"For a caller that relays answers itself (a messaging channel). Names the tool that relays the result of a SCHEDULE created during this turn: the schedule copies it, and after each of its runs — succeeded or failed — the tool is called as the schedule's owner, with their stored tool credentials, with `{ ...input, [result_key]: { text, attachments, run_id, schedule_id, automation_name, status, error } }`. This run itself does nothing with it: you relay its answer as usual. The agent never sees the field and cannot change it.","required":["tool"],"properties":{"tool":{"type":"string","description":"Runtime name of the tool, as an agent of the organization sees it (the `id` in GET /v1/tools).","example":"pms_deliver_scheduled_message","isRequired":true,"uniqueKey":"delivery.tool","typeLabel":"string"},"input":{"type":"object","description":"Fixed arguments sent with every delivery, next to the result.","example":{"p_property_id":"0b9f6c1e-3a52-4f7d-9d0e-6a1c2b3d4e5f"},"uniqueKey":"delivery.input","typeLabel":"object"},"result_key":{"type":"string","default":"result","description":"Name of the argument that receives the result object.","example":"p_result","uniqueKey":"delivery.result_key","typeLabel":"string"}},"uniqueKey":"delivery","typeLabel":"object"},"automation_confirmation":{"type":"string","enum":["card","text"],"default":"card","description":"How the user approves an automation the agent builds in this turn. `card` (default): the turn pauses on the workflow card (`data-tool-call-suspended`), which a chat UI shows with Test and Approve. `text`: for a channel that cannot show a card — the agent says in words what will be sent and when, the user replies yes in a later message (same `threadId`), and only then is the automation saved and scheduled. The turn never pauses.","uniqueKey":"automation_confirmation","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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,"mode":"dashboard","dashboardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","automation_confirmation":"card"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4c2a921c-9add-47ac-9d7e-27e2ee2e080d":{"description":"The finished turn","content":{"application/json":{"schema":{"type":"object","properties":{"threadId":{"type":"string","description":"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.","uniqueKey":"threadId","typeLabel":"string"},"requestId":{"oneOf":[{"type":"string","description":"Correlation id for this run; the join key for its traces and cost.","uniqueKey":"requestId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Correlation id for this run; the join key for its traces and cost.","uniqueKey":"requestId.oneOf.1","typeLabel":"null"}],"uniqueKey":"requestId","typeLabel":"string | null"},"text":{"type":"string","description":"The agent's answer. When a step of the turn was redone (a `data-step-redo` part in `data`), only what the agent wrote after the redo: the text it withdrew is not part of the answer.","uniqueKey":"text","typeLabel":"string"},"reasoning":{"type":"string","description":"Reasoning text, when the model emitted any. Absent otherwise.","uniqueKey":"reasoning","typeLabel":"string"},"toolCalls":{"type":"array","description":"The tools the agent called, in order, each with its input and either its output or the error it failed with.","items":{"type":"object","properties":{"toolCallId":{"type":"string","uniqueKey":"toolCalls.items.[INDEX].toolCallId","typeLabel":"string"},"toolName":{"type":"string","uniqueKey":"toolCalls.items.[INDEX].toolName","typeLabel":"string"},"input":{"type":"object","uniqueKey":"toolCalls.items.[INDEX].input","typeLabel":"object"},"output":{"type":"object","uniqueKey":"toolCalls.items.[INDEX].output","typeLabel":"object"},"error":{"type":"string","uniqueKey":"toolCalls.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"toolCalls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"toolCalls","typeLabel":"object[]"},"data":{"type":"array","description":"Custom parts the run emitted: `data-handoff` (which agent a network routed to), `data-tool-workflow` (workflow step progress), `data-tool-progress-message` (the one-line progress message of a tool call, for a live UI), `data-step-redo` (the agent's reply was rejected by a platform check and written again; `text` holds the final one), 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.","items":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"data.items.[INDEX].type","typeLabel":"string"},"data":{"type":"object","uniqueKey":"data.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"},"errors":{"type":"array","description":"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.","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"},"finishReason":{"type":"string","uniqueKey":"finishReason","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"threadId":"\u003cstring>","requestId":"\u003cstring>","text":"\u003cstring>","reasoning":"\u003cstring>","toolCalls":[{"toolCallId":"\u003cstring>","toolName":"\u003cstring>","input":{},"output":{},"error":"\u003cstring>"}],"data":[{"type":"\u003cstring>","data":{}}],"errors":["\u003cstring>"],"finishReason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cac2bd28-8158-49e6-b86d-5713834a9bbe":{"description":"Invalid body, or no messages","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ae5cd293-974f-41cb-9b7d-96292d48d330":{"description":"Thread belongs to another organization","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"56bd8e17-ce37-4d42-8a33-766696daab5d":{"description":"Agent or network not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"faa6c81f-e434-47c2-9f50-73bed5936a72":{"description":"Usage limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"c9522795-f46b-45e9-a28e-1a91137ca6ef":{"sessionToken":{"type":"http","scheme":"bearer","description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","scopes":[],"schemeName":"sessionToken"}}},"servers":{"5a9ef6cd-d896-47ca-98f0-fbb8d6f1aa96":{"url":"https://api.sidenet.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","scopes":[],"schemeName":"sessionToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"sessionToken","name":"Authorization"}],"title":"sessionToken"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sidenetai","siteName":"Sidenet API","title":"Run network - Sidenet API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T17:51:29.035Z","originalFileLocation":"api-reference/chat/run-network.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sidenet API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run network - Sidenet API\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sidenet API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.sidenet.ai/api-reference/chat/run-network\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sidenetai.mintlify.site/docs/_mintlify/api/og/v2?division=Chat+%26+Messaging\u0026amp;title=Run+network\u0026amp;description=Runs+the+network+against+%60messages%60.+When+the+network+has+more+than+one+agent%2C+routing+picks+which+one+answers+%28send+%60use_routing%3A+false%60+to+take+the+default+ag\u0026amp;theme=a1e7f929b234304c081618fd\u0026amp;signature=ddd0a7ee94359667d7cba43ab35a206cd2cb09b092a8ffafed67769afa00714a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run network - Sidenet API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sidenetai.mintlify.site/docs/_mintlify/api/og/v2?division=Chat+%26+Messaging\u0026amp;title=Run+network\u0026amp;description=Runs+the+network+against+%60messages%60.+When+the+network+has+more+than+one+agent%2C+routing+picks+which+one+answers+%28send+%60use_routing%3A+false%60+to+take+the+default+ag\u0026amp;theme=a1e7f929b234304c081618fd\u0026amp;signature=ddd0a7ee94359667d7cba43ab35a206cd2cb09b092a8ffafed67769afa00714a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sidenet API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.sidenet.ai/api-reference/chat/run-network\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/chat/run-network.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.sidenet.ai/#organization\",\"name\":\"Sidenet API\",\"url\":\"https://www.sidenet.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-light.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=206c6acd674e00cc951ff99d54600daa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.sidenet.ai#website\",\"name\":\"Sidenet API\",\"url\":\"https://www.sidenet.ai\",\"publisher\":{\"@id\":\"https://www.sidenet.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.sidenet.ai/api-reference/chat/run-network#webpage\",\"url\":\"https://www.sidenet.ai/api-reference/chat/run-network\",\"name\":\"Run network\",\"description\":\"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.\",\"dateModified\":\"2026-11-15T17:51:29.035Z\",\"isPartOf\":{\"@id\":\"https://www.sidenet.ai#website\"},\"breadcrumb\":{\"@id\":\"https://www.sidenet.ai/api-reference/chat/run-network#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.sidenet.ai/api-reference/chat/run-network#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Chat \u0026 Messaging\",\"item\":\"https://www.sidenet.ai/api-reference/chat/stream-chat\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run network\",\"item\":\"https://www.sidenet.ai/api-reference/chat/run-network\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.sidenet.ai/api-reference/chat/run-network#apireference\",\"headline\":\"Run network\",\"name\":\"Run network\",\"description\":\"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.\",\"url\":\"https://www.sidenet.ai/api-reference/chat/run-network\",\"mainEntityOfPage\":{\"@id\":\"https://www.sidenet.ai/api-reference/chat/run-network#webpage\"},\"dateModified\":\"2026-11-15T17:51:29.035Z\",\"publisher\":{\"@id\":\"https://www.sidenet.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.sidenet.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sidenet API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sidenet API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/chat/run-network.md","siteName":"Sidenet API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/concepts"}]},{"tab":"API Reference","groups":[{"group":"Overview","root":{"title":"Overview","href":"/api-reference/overview"},"pages":[]},{"group":"Authentication","pages":[{"title":"Mint session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/token","href":"/api-reference/authentication/mint-session-token"},{"title":"Refresh session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/token/refresh","href":"/api-reference/authentication/refresh-session-token"},{"title":"List runtime auth providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tools-auth","href":"/api-reference/authentication/list-runtime-auth-providers"}]},{"group":"Users \u0026 Groups","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users","href":"/api-reference/users-\u0026-groups/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/users","href":"/api-reference/users-\u0026-groups/create-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/users/{userId}","href":"/api-reference/users-\u0026-groups/update-user"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/groups","href":"/api-reference/users-\u0026-groups/list-groups"},{"title":"Create group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/groups","href":"/api-reference/users-\u0026-groups/create-group"},{"title":"Update group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/groups/{groupId}","href":"/api-reference/users-\u0026-groups/update-group"}]},{"group":"Organizations","pages":[{"title":"Create organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs","href":"/api-reference/organizations/create-organization"},{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/orgs","href":"/api-reference/organizations/list-organizations"},{"title":"Suspend organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs/{id}/suspend","href":"/api-reference/organizations/suspend-organization"},{"title":"Resume organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs/{id}/resume","href":"/api-reference/organizations/resume-organization"}]},{"group":"Billing","pages":[{"title":"Get credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/balance","href":"/api-reference/billing/get-credit-balance"},{"title":"List credit transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/transactions","href":"/api-reference/billing/list-credit-transactions"},{"title":"List usage invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/invoices","href":"/api-reference/billing/list-usage-invoices"}]},{"group":"Chat \u0026 Messaging","pages":[{"title":"Stream chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/chat","href":"/api-reference/chat/stream-chat"},{"title":"Run agent","description":"Runs the agent's active published version against `messages`. Send `agentVersionId` to run a specific version (a draft, or an older published one) instead. 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.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/run","href":"/api-reference/chat/run-agent"},{"title":"Run network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/run","href":"/api-reference/chat/run-network"},{"title":"Resume stream","description":"Replays the buffered UIMessage chunks of the thread's in-flight chat turn from the start, then continues streaming live. The first chunk is a transient `data-resume-state` part whose `data.done` says whether the turn is still running (`false`: the replay is followed by the live tail; `true`: a finished turn replayed within its retention window). Returns 204 when there is nothing to resume.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/chat/stream","href":"/api-reference/chat/resume-stream"},{"title":"Cancel stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/chat/stream","href":"/api-reference/chat/cancel-stream"},{"title":"List threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/threads","href":"/api-reference/chat/list-threads"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/messages","href":"/api-reference/chat/list-messages"},{"title":"Vote on message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/vote","href":"/api-reference/chat/vote-on-message"},{"title":"Mark thread read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/threads/{id}/read","href":"/api-reference/chat/mark-thread-read"},{"title":"Append thread messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/threads/{id}/messages","href":"/api-reference/chat/append-thread-messages"},{"title":"Delete thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/threads/{id}","href":"/api-reference/chat/delete-thread"},{"title":"Transcribe audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audio/transcriptions","href":"/api-reference/chat/transcribe-audio"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Save agent draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{id}/draft","href":"/api-reference/agents/save-agent-draft"},{"title":"Preview agent prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/instructions/preview","href":"/api-reference/agents/preview-agent-prompt"},{"title":"Publish agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/publish","href":"/api-reference/agents/publish-agent"},{"title":"Activate agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/activate","href":"/api-reference/agents/activate-agent-version"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{id}/versions","href":"/api-reference/agents/list-agent-versions"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-agent"}]},{"group":"Prompt Blocks","pages":[{"title":"List prompt blocks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks","href":"/api-reference/prompt-blocks/list-prompt-blocks"},{"title":"Create prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks","href":"/api-reference/prompt-blocks/create-prompt-block"},{"title":"Get prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}","href":"/api-reference/prompt-blocks/get-prompt-block"},{"title":"Save block draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/prompt-blocks/{id}/draft","href":"/api-reference/prompt-blocks/save-block-draft"},{"title":"Publish prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/publish","href":"/api-reference/prompt-blocks/publish-prompt-block"},{"title":"Activate block version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/activate","href":"/api-reference/prompt-blocks/activate-block-version"},{"title":"List block versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}/versions","href":"/api-reference/prompt-blocks/list-block-versions"},{"title":"List block references","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}/references","href":"/api-reference/prompt-blocks/list-block-references"},{"title":"Roll out block version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/rollout","href":"/api-reference/prompt-blocks/roll-out-block-version"},{"title":"Preview block content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/preview","href":"/api-reference/prompt-blocks/preview-block-content"},{"title":"Delete prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/prompt-blocks/{id}","href":"/api-reference/prompt-blocks/delete-prompt-block"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills","href":"/api-reference/skills/list-skills"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills","href":"/api-reference/skills/create-skill"},{"title":"Get skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}","href":"/api-reference/skills/get-skill"},{"title":"Save skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/skills/{id}","href":"/api-reference/skills/save-skill"},{"title":"Publish skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills/{id}/publish","href":"/api-reference/skills/publish-skill"},{"title":"Activate skill version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills/{id}/activate","href":"/api-reference/skills/activate-skill-version"},{"title":"List skill versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}/versions","href":"/api-reference/skills/list-skill-versions"},{"title":"List skill references","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}/references","href":"/api-reference/skills/list-skill-references"},{"title":"Delete skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/skills/{id}","href":"/api-reference/skills/delete-skill"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/{id}","href":"/api-reference/workflows/get-workflow"},{"title":"Save workflow draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workflows/{id}/draft","href":"/api-reference/workflows/save-workflow-draft"},{"title":"Publish workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/publish","href":"/api-reference/workflows/publish-workflow"},{"title":"Activate workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/activate","href":"/api-reference/workflows/activate-workflow-version"},{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/{id}/versions","href":"/api-reference/workflows/list-workflow-versions"},{"title":"Run workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/run","href":"/api-reference/workflows/run-workflow"},{"title":"Get workflow schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/definition-schema","href":"/api-reference/workflows/get-workflow-schema"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workflows/{id}","href":"/api-reference/workflows/delete-workflow"}]},{"group":"Approvals","pages":[{"title":"List my approval requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/approval-requests","href":"/api-reference/approvals/list-my-approval-requests"},{"title":"Get approval request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/approval-requests/{ref}","href":"/api-reference/approvals/get-approval-request"},{"title":"Decide approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/approval-requests/{ref}/decide","href":"/api-reference/approvals/decide-approval"}]},{"group":"Workflow Schedules","pages":[{"title":"List workflow schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules","href":"/api-reference/workflows/list-workflow-schedules"},{"title":"Create workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules","href":"/api-reference/workflows/create-workflow-schedule"},{"title":"Preview schedule timing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/preview","href":"/api-reference/workflows/preview-schedule-timing"},{"title":"Get workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/{id}","href":"/api-reference/workflows/get-workflow-schedule"},{"title":"Update workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workflow-schedules/{id}","href":"/api-reference/workflows/update-workflow-schedule"},{"title":"Delete workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workflow-schedules/{id}","href":"/api-reference/workflows/delete-workflow-schedule"},{"title":"Pause workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/pause","href":"/api-reference/workflows/pause-workflow-schedule"},{"title":"Resume workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/resume","href":"/api-reference/workflows/resume-workflow-schedule"},{"title":"Run workflow schedule now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/run-now","href":"/api-reference/workflows/run-workflow-schedule-now"},{"title":"List schedule runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/{id}/runs","href":"/api-reference/workflows/list-schedule-runs"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-runs","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Get workflow run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-runs/{id}","href":"/api-reference/workflows/get-workflow-run"}]},{"group":"Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards","href":"/api-reference/dashboards/list-dashboards"},{"title":"Create dashboard from spec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards","href":"/api-reference/dashboards/create-dashboard-from-spec"},{"title":"List dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/templates","href":"/api-reference/dashboards/list-dashboard-templates"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}","href":"/api-reference/dashboards/get-dashboard"},{"title":"Refresh dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/refresh","href":"/api-reference/dashboards/refresh-dashboard"},{"title":"Get dashboard refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}/runs/{runId}","href":"/api-reference/dashboards/get-dashboard-refresh"},{"title":"Run dashboard view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/views/{viewId}/run","href":"/api-reference/dashboards/run-dashboard-view"},{"title":"List dashboard versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}/versions","href":"/api-reference/dashboards/list-dashboard-versions"},{"title":"Activate dashboard version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/activate","href":"/api-reference/dashboards/activate-dashboard-version"},{"title":"Rename dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/dashboards/{id}","href":"/api-reference/dashboards/rename-dashboard"},{"title":"Delete dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/dashboards/{id}","href":"/api-reference/dashboards/delete-dashboard"}]},{"group":"Dashboard templates","pages":[{"title":"List stored dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates","href":"/api-reference/dashboard-templates/list-stored-dashboard-templates"},{"title":"Get dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/get-dashboard-template"},{"title":"Save dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/save-dashboard-template"},{"title":"Update dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/update-dashboard-template"},{"title":"Delete dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/delete-dashboard-template"},{"title":"Publish dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboard-templates/publish","href":"/api-reference/dashboard-templates/publish-dashboard-templates"},{"title":"Get dashboard template publish state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates/state","href":"/api-reference/dashboard-templates/get-dashboard-template-publish-state"}]},{"group":"Browser","pages":[{"title":"Open a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions","href":"/api-reference/browser/open-a-browser-session"},{"title":"List browser sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions","href":"/api-reference/browser/list-browser-sessions"},{"title":"Get a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}","href":"/api-reference/browser/get-a-browser-session"},{"title":"Get the live view of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/live-view","href":"/api-reference/browser/get-the-live-view-of-a-browser-session"},{"title":"Get a still of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/still","href":"/api-reference/browser/get-a-still-of-a-browser-session"},{"title":"Get the replay of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/replay","href":"/api-reference/browser/get-the-replay-of-a-browser-session"},{"title":"Get one page of a replay","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/replay/{page}","href":"/api-reference/browser/get-one-page-of-a-replay"},{"title":"Open a tab","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/tabs","href":"/api-reference/browser/open-a-tab"},{"title":"Close a tab","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/browser-sessions/{id}/tabs/{index}","href":"/api-reference/browser/close-a-tab"},{"title":"Take over a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/take-over","href":"/api-reference/browser/take-over-a-browser-session"},{"title":"Hand a browser session back to the agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/hand-back","href":"/api-reference/browser/hand-a-browser-session-back-to-the-agent"},{"title":"Pause the agent in a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/pause","href":"/api-reference/browser/pause-the-agent-in-a-browser-session"},{"title":"Resume the agent in a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/resume","href":"/api-reference/browser/resume-the-agent-in-a-browser-session"},{"title":"Stop a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/stop","href":"/api-reference/browser/stop-a-browser-session"},{"title":"Hand a browser session to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/attach","href":"/api-reference/browser/hand-a-browser-session-to-an-agent"},{"title":"Keep the sign-in of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/keep-sign-in","href":"/api-reference/browser/keep-the-sign-in-of-a-browser-session"},{"title":"Delete a saved login","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/browser-saved-logins/{ref}","href":"/api-reference/browser/delete-a-saved-login"}]},{"group":"Networks","pages":[{"title":"List networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/networks","href":"/api-reference/networks/list-networks"},{"title":"Create network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/networks","href":"/api-reference/networks/create-network"},{"title":"Get network copilots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/networks/{id}","href":"/api-reference/networks/get-network-copilots"},{"title":"Rename network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/networks/{id}","href":"/api-reference/networks/rename-network"},{"title":"Get network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/copilots/{id}","href":"/api-reference/networks/get-network"},{"title":"Update network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/copilots/{id}","href":"/api-reference/networks/update-network"},{"title":"Attach agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/agents","href":"/api-reference/networks/attach-agent"},{"title":"Detach agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/copilots/{id}/agents/{agentId}","href":"/api-reference/networks/detach-agent"},{"title":"Attach workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/workflows","href":"/api-reference/networks/attach-workflow"},{"title":"Detach workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/copilots/{id}/workflows/{workflowId}","href":"/api-reference/networks/detach-workflow"},{"title":"Deploy network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/deploy","href":"/api-reference/networks/deploy-network"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Execute tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tools/{toolId}/execute","href":"/api-reference/tools/execute-tool"},{"title":"Create tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tools","href":"/api-reference/tools/create-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tools/{id}","href":"/api-reference/tools/update-tool"},{"title":"Delete tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tools/{id}","href":"/api-reference/tools/delete-tool"}]},{"group":"Tool Providers","pages":[{"title":"List tool providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tool-providers","href":"/api-reference/tool-providers/list-tool-providers"},{"title":"Create tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tool-providers","href":"/api-reference/tool-providers/create-tool-provider"},{"title":"Get tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tool-providers/{id}","href":"/api-reference/tool-providers/get-tool-provider"},{"title":"Update tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tool-providers/{id}","href":"/api-reference/tool-providers/update-tool-provider"},{"title":"Save provider tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tool-providers/{id}/tools","href":"/api-reference/tool-providers/save-provider-tools"},{"title":"Delete tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tool-providers/{id}","href":"/api-reference/tool-providers/delete-tool-provider"},{"title":"Grant tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tool-providers/{id}/grants","href":"/api-reference/tool-providers/grant-tool-provider"},{"title":"Revoke tool provider grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tool-providers/{id}/grants/{org_id}","href":"/api-reference/tool-providers/revoke-tool-provider-grant"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets","href":"/api-reference/datasets/list-datasets"},{"title":"Create dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets","href":"/api-reference/datasets/create-dataset"},{"title":"Get dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}","href":"/api-reference/datasets/get-dataset"},{"title":"Update dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/datasets/{id}","href":"/api-reference/datasets/update-dataset"},{"title":"Delete dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/datasets/{id}","href":"/api-reference/datasets/delete-dataset"},{"title":"List dataset items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}/items","href":"/api-reference/datasets/list-dataset-items"},{"title":"Add dataset items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets/{id}/items","href":"/api-reference/datasets/add-dataset-items"},{"title":"Update dataset item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/datasets/{id}/items/{itemId}","href":"/api-reference/datasets/update-dataset-item"},{"title":"Delete dataset item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/datasets/{id}/items/{itemId}","href":"/api-reference/datasets/delete-dataset-item"}]},{"group":"Scoring \u0026 Experiments","pages":[{"title":"Run experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/experiments","href":"/api-reference/experiments/run-experiment"},{"title":"Get experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/experiments/{experimentId}","href":"/api-reference/experiments/get-experiment"},{"title":"Delete experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/experiments/{experimentId}","href":"/api-reference/experiments/delete-experiment"},{"title":"List experiments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}/experiments","href":"/api-reference/experiments/list-experiments"},{"title":"Compare experiments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets/{id}/compare","href":"/api-reference/experiments/compare-experiments"},{"title":"Score traces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/score-trace","href":"/api-reference/experiments/score-traces"},{"title":"List trace scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/traces/{traceId}/scores","href":"/api-reference/experiments/list-trace-scores"}]},{"group":"Observability","pages":[{"title":"List requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests","href":"/api-reference/observability/list-requests"},{"title":"Get a request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/{id}","href":"/api-reference/observability/get-a-request"},{"title":"Request statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/stats","href":"/api-reference/observability/request-statistics"},{"title":"Request filter options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/filters","href":"/api-reference/observability/request-filter-options"}]},{"group":"System","pages":[{"title":"Rebuild agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/rebuild","href":"/api-reference/system/rebuild-agents"},{"title":"Rebuild org tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rebuild-org-tools","href":"/api-reference/system/rebuild-org-tools"}]}]},{"tab":"Chat SDK","pages":[{"title":"Chat SDK","href":"/sdk/overview"}]}]},"basePath":"","title":"Run network - Sidenet API","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CQGbdtm4.js","utils-D88A1f-Z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChqWdz1A.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-yBrxdh_6.js","snippetPresets-BgqDrFJC.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Duxc2rZw.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C7jidOil.js","shallow-xkjpHm-U.js","getApiPlaygroundDisplay-fE3rVpvL.js","CodeSnippet-LgxljKed.js","CodeSnippets-D-pXWDHq.js","Page-C2-BijcO.js","getPastedJson-CLRcu-uo.js","icon-Cxirpjgo.js","MethodPill-D49eqY5e.js","DuplicateIcon-CivCz5Rp.js","createIcon-D71qL3f5.js","DynamicMarkdown-BcGRTrw6.js","SectionHeading-DzaqmmSD.js","axios-vUo_bRtp.js","Markdown-CZqUYmMp.js","clsx-B6IZIRsp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B0ZV6X5T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-MqLyPtsW.js"]}