operations
const operations: object;Where each operation is served, and how its input travels.
Type Declaration
Section titled “Type Declaration”agents.list
Section titled “agents.list”readonly agents.list: object;agents.list.method
Section titled “agents.list.method”readonly method: "GET" = "GET";agents.list.path
Section titled “agents.list.path”readonly path: "/v1/agents" = "/v1/agents";agents.list.path_params
Section titled “agents.list.path_params”readonly path_params: readonly [] = [];agents.list.query
Section titled “agents.list.query”readonly query: readonly ["agents"];agents.list.body
Section titled “agents.list.body”readonly body: false = false;agents.list.unwrap
Section titled “agents.list.unwrap”readonly unwrap: "agents" = "agents";agents.forget
Section titled “agents.forget”readonly agents.forget: object;agents.forget.method
Section titled “agents.forget.method”readonly method: "DELETE" = "DELETE";agents.forget.path
Section titled “agents.forget.path”readonly path: "/v1/agents" = "/v1/agents";agents.forget.path_params
Section titled “agents.forget.path_params”readonly path_params: readonly [] = [];agents.forget.query
Section titled “agents.forget.query”readonly query: readonly ["agents"];agents.forget.body
Section titled “agents.forget.body”readonly body: false = false;interrupts.list
Section titled “interrupts.list”readonly interrupts.list: object;interrupts.list.method
Section titled “interrupts.list.method”readonly method: "GET" = "GET";interrupts.list.path
Section titled “interrupts.list.path”readonly path: "/v1/interrupts" = "/v1/interrupts";interrupts.list.path_params
Section titled “interrupts.list.path_params”readonly path_params: readonly [] = [];interrupts.list.query
Section titled “interrupts.list.query”readonly query: readonly ["agents"];interrupts.list.body
Section titled “interrupts.list.body”readonly body: false = false;interrupts.list.unwrap
Section titled “interrupts.list.unwrap”readonly unwrap: "interrupts" = "interrupts";events.list
Section titled “events.list”readonly events.list: object;events.list.method
Section titled “events.list.method”readonly method: "GET" = "GET";events.list.path
Section titled “events.list.path”readonly path: "/v1/events" = "/v1/events";events.list.path_params
Section titled “events.list.path_params”readonly path_params: readonly [] = [];events.list.query
Section titled “events.list.query”readonly query: readonly ["agents", "types", "after", "limit"];events.list.body
Section titled “events.list.body”readonly body: false = false;events.list.stream
Section titled “events.list.stream”readonly stream: true = true;events.head
Section titled “events.head”readonly events.head: object;events.head.method
Section titled “events.head.method”readonly method: "GET" = "GET";events.head.path
Section titled “events.head.path”readonly path: "/v1/events/head" = "/v1/events/head";events.head.path_params
Section titled “events.head.path_params”readonly path_params: readonly [] = [];events.head.query
Section titled “events.head.query”readonly query: readonly ["agents"];events.head.body
Section titled “events.head.body”readonly body: false = false;events.head.unwrap
Section titled “events.head.unwrap”readonly unwrap: "cursor" = "cursor";agent.read
Section titled “agent.read”readonly agent.read: object;agent.read.method
Section titled “agent.read.method”readonly method: "GET" = "GET";agent.read.path
Section titled “agent.read.path”readonly path: "/v1/agents/{agent}" = "/v1/agents/{agent}";agent.read.conversation
Section titled “agent.read.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}" = "/v1/agents/{agent}/conversations/{conversation}";agent.read.path_params
Section titled “agent.read.path_params”readonly path_params: readonly ["agent"];agent.read.query
Section titled “agent.read.query”readonly query: readonly [] = [];agent.read.body
Section titled “agent.read.body”readonly body: false = false;agent.define
Section titled “agent.define”readonly agent.define: object;agent.define.method
Section titled “agent.define.method”readonly method: "PUT" = "PUT";agent.define.path
Section titled “agent.define.path”readonly path: "/v1/agents/{agent}" = "/v1/agents/{agent}";agent.define.path_params
Section titled “agent.define.path_params”readonly path_params: readonly ["agent"];agent.define.query
Section titled “agent.define.query”readonly query: readonly [] = [];agent.define.body
Section titled “agent.define.body”readonly body: true = true;agent.forget
Section titled “agent.forget”readonly agent.forget: object;agent.forget.method
Section titled “agent.forget.method”readonly method: "DELETE" = "DELETE";agent.forget.path
Section titled “agent.forget.path”readonly path: "/v1/agents/{agent}" = "/v1/agents/{agent}";agent.forget.path_params
Section titled “agent.forget.path_params”readonly path_params: readonly ["agent"];agent.forget.query
Section titled “agent.forget.query”readonly query: readonly [] = [];agent.forget.body
Section titled “agent.forget.body”readonly body: false = false;agent.ask
Section titled “agent.ask”readonly agent.ask: object;agent.ask.method
Section titled “agent.ask.method”readonly method: "POST" = "POST";agent.ask.path
Section titled “agent.ask.path”readonly path: "/v1/agents/{agent}/messages" = "/v1/agents/{agent}/messages";agent.ask.conversation
Section titled “agent.ask.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/messages" = "/v1/agents/{agent}/conversations/{conversation}/messages";agent.ask.path_params
Section titled “agent.ask.path_params”readonly path_params: readonly ["agent"];agent.ask.query
Section titled “agent.ask.query”readonly query: readonly [] = [];agent.ask.body
Section titled “agent.ask.body”readonly body: true = true;agent.ask.unwrap
Section titled “agent.ask.unwrap”readonly unwrap: "message" = "message";agent.decide
Section titled “agent.decide”readonly agent.decide: object;agent.decide.method
Section titled “agent.decide.method”readonly method: "POST" = "POST";agent.decide.path
Section titled “agent.decide.path”readonly path: "/v1/agents/{agent}/decisions" = "/v1/agents/{agent}/decisions";agent.decide.conversation
Section titled “agent.decide.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/decisions" = "/v1/agents/{agent}/conversations/{conversation}/decisions";agent.decide.path_params
Section titled “agent.decide.path_params”readonly path_params: readonly ["agent"];agent.decide.query
Section titled “agent.decide.query”readonly query: readonly [] = [];agent.decide.body
Section titled “agent.decide.body”readonly body: true = true;agent.decide.unwrap
Section titled “agent.decide.unwrap”readonly unwrap: "decisions" = "decisions";agent.authorization
Section titled “agent.authorization”readonly agent.authorization: object;agent.authorization.method
Section titled “agent.authorization.method”readonly method: "GET" = "GET";agent.authorization.path
Section titled “agent.authorization.path”readonly path: "/v1/agents/{agent}/interrupts/{interrupt}/authorization" = "/v1/agents/{agent}/interrupts/{interrupt}/authorization";agent.authorization.conversation
Section titled “agent.authorization.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/authorization" = "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/authorization";agent.authorization.path_params
Section titled “agent.authorization.path_params”readonly path_params: readonly ["agent", "interrupt"];agent.authorization.query
Section titled “agent.authorization.query”readonly query: readonly [] = [];agent.authorization.body
Section titled “agent.authorization.body”readonly body: false = false;agent.cancel
Section titled “agent.cancel”readonly agent.cancel: object;agent.cancel.method
Section titled “agent.cancel.method”readonly method: "POST" = "POST";agent.cancel.path
Section titled “agent.cancel.path”readonly path: "/v1/agents/{agent}/cancel" = "/v1/agents/{agent}/cancel";agent.cancel.conversation
Section titled “agent.cancel.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/cancel" = "/v1/agents/{agent}/conversations/{conversation}/cancel";agent.cancel.path_params
Section titled “agent.cancel.path_params”readonly path_params: readonly ["agent"];agent.cancel.query
Section titled “agent.cancel.query”readonly query: readonly [] = [];agent.cancel.body
Section titled “agent.cancel.body”readonly body: false = false;agent.events
Section titled “agent.events”readonly agent.events: object;agent.events.method
Section titled “agent.events.method”readonly method: "GET" = "GET";agent.events.path
Section titled “agent.events.path”readonly path: "/v1/agents/{agent}/events" = "/v1/agents/{agent}/events";agent.events.conversation
Section titled “agent.events.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/events" = "/v1/agents/{agent}/conversations/{conversation}/events";agent.events.path_params
Section titled “agent.events.path_params”readonly path_params: readonly ["agent"];agent.events.query
Section titled “agent.events.query”readonly query: readonly ["types", "after", "limit"];agent.events.body
Section titled “agent.events.body”readonly body: false = false;agent.events.stream
Section titled “agent.events.stream”readonly stream: true = true;agent.timeline
Section titled “agent.timeline”readonly agent.timeline: object;agent.timeline.method
Section titled “agent.timeline.method”readonly method: "GET" = "GET";agent.timeline.path
Section titled “agent.timeline.path”readonly path: "/v1/agents/{agent}/timeline" = "/v1/agents/{agent}/timeline";agent.timeline.conversation
Section titled “agent.timeline.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/timeline" = "/v1/agents/{agent}/conversations/{conversation}/timeline";agent.timeline.path_params
Section titled “agent.timeline.path_params”readonly path_params: readonly ["agent"];agent.timeline.query
Section titled “agent.timeline.query”readonly query: readonly [] = [];agent.timeline.body
Section titled “agent.timeline.body”readonly body: false = false;agent.runs
Section titled “agent.runs”readonly agent.runs: object;agent.runs.method
Section titled “agent.runs.method”readonly method: "GET" = "GET";agent.runs.path
Section titled “agent.runs.path”readonly path: "/v1/agents/{agent}/runs" = "/v1/agents/{agent}/runs";agent.runs.conversation
Section titled “agent.runs.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/runs" = "/v1/agents/{agent}/conversations/{conversation}/runs";agent.runs.path_params
Section titled “agent.runs.path_params”readonly path_params: readonly ["agent"];agent.runs.query
Section titled “agent.runs.query”readonly query: readonly [] = [];agent.runs.body
Section titled “agent.runs.body”readonly body: false = false;audit.list
Section titled “audit.list”readonly audit.list: object;audit.list.method
Section titled “audit.list.method”readonly method: "GET" = "GET";audit.list.path
Section titled “audit.list.path”readonly path: "/v1/deployment/audit" = "/v1/deployment/audit";audit.list.path_params
Section titled “audit.list.path_params”readonly path_params: readonly [] = [];audit.list.query
Section titled “audit.list.query”readonly query: readonly ["starting_after", "limit"];audit.list.body
Section titled “audit.list.body”readonly body: false = false;agent.approve
Section titled “agent.approve”readonly agent.approve: object;agent.approve.method
Section titled “agent.approve.method”readonly method: "POST" = "POST";agent.approve.path
Section titled “agent.approve.path”readonly path: "/v1/agents/{agent}/interrupts/{interrupt}/approve" = "/v1/agents/{agent}/interrupts/{interrupt}/approve";agent.approve.conversation
Section titled “agent.approve.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/approve" = "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/approve";agent.approve.path_params
Section titled “agent.approve.path_params”readonly path_params: readonly ["agent", "interrupt"];agent.approve.query
Section titled “agent.approve.query”readonly query: readonly [] = [];agent.approve.body
Section titled “agent.approve.body”readonly body: true = true;agent.approve.unwrap
Section titled “agent.approve.unwrap”readonly unwrap: "decisions" = "decisions";agent.deny
Section titled “agent.deny”readonly agent.deny: object;agent.deny.method
Section titled “agent.deny.method”readonly method: "POST" = "POST";agent.deny.path
Section titled “agent.deny.path”readonly path: "/v1/agents/{agent}/interrupts/{interrupt}/deny" = "/v1/agents/{agent}/interrupts/{interrupt}/deny";agent.deny.conversation
Section titled “agent.deny.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/deny" = "/v1/agents/{agent}/conversations/{conversation}/interrupts/{interrupt}/deny";agent.deny.path_params
Section titled “agent.deny.path_params”readonly path_params: readonly ["agent", "interrupt"];agent.deny.query
Section titled “agent.deny.query”readonly query: readonly [] = [];agent.deny.body
Section titled “agent.deny.body”readonly body: true = true;agent.deny.unwrap
Section titled “agent.deny.unwrap”readonly unwrap: "decisions" = "decisions";agents.cancel
Section titled “agents.cancel”readonly agents.cancel: object;agents.cancel.method
Section titled “agents.cancel.method”readonly method: "POST" = "POST";agents.cancel.path
Section titled “agents.cancel.path”readonly path: "/v1/agents/cancel" = "/v1/agents/cancel";agents.cancel.path_params
Section titled “agents.cancel.path_params”readonly path_params: readonly [] = [];agents.cancel.query
Section titled “agents.cancel.query”readonly query: readonly ["agents"];agents.cancel.body
Section titled “agents.cancel.body”readonly body: false = false;agents.cancel.unwrap
Section titled “agents.cancel.unwrap”readonly unwrap: "cancelled" = "cancelled";agent.definition
Section titled “agent.definition”readonly agent.definition: object;agent.definition.method
Section titled “agent.definition.method”readonly method: "GET" = "GET";agent.definition.path
Section titled “agent.definition.path”readonly path: "/v1/agents/{agent}/definition" = "/v1/agents/{agent}/definition";agent.definition.path_params
Section titled “agent.definition.path_params”readonly path_params: readonly ["agent"];agent.definition.query
Section titled “agent.definition.query”readonly query: readonly [] = [];agent.definition.body
Section titled “agent.definition.body”readonly body: false = false;agent.spawn
Section titled “agent.spawn”readonly agent.spawn: object;agent.spawn.method
Section titled “agent.spawn.method”readonly method: "POST" = "POST";agent.spawn.path
Section titled “agent.spawn.path”readonly path: "/v1/agents/{agent}/spawn" = "/v1/agents/{agent}/spawn";agent.spawn.path_params
Section titled “agent.spawn.path_params”readonly path_params: readonly ["agent"];agent.spawn.query
Section titled “agent.spawn.query”readonly query: readonly [] = [];agent.spawn.body
Section titled “agent.spawn.body”readonly body: false = false;agent.spawn.unwrap
Section titled “agent.spawn.unwrap”readonly unwrap: "agent" = "agent";agent.stop
Section titled “agent.stop”readonly agent.stop: object;agent.stop.method
Section titled “agent.stop.method”readonly method: "POST" = "POST";agent.stop.path
Section titled “agent.stop.path”readonly path: "/v1/agents/{agent}/stop" = "/v1/agents/{agent}/stop";agent.stop.conversation
Section titled “agent.stop.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/stop" = "/v1/agents/{agent}/conversations/{conversation}/stop";agent.stop.path_params
Section titled “agent.stop.path_params”readonly path_params: readonly ["agent"];agent.stop.query
Section titled “agent.stop.query”readonly query: readonly [] = [];agent.stop.body
Section titled “agent.stop.body”readonly body: false = false;agent.stop.unwrap
Section titled “agent.stop.unwrap”readonly unwrap: "agent" = "agent";agent.clear
Section titled “agent.clear”readonly agent.clear: object;agent.clear.method
Section titled “agent.clear.method”readonly method: "DELETE" = "DELETE";agent.clear.path
Section titled “agent.clear.path”readonly path: "/v1/agents/{agent}/conversation" = "/v1/agents/{agent}/conversation";agent.clear.conversation
Section titled “agent.clear.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}" = "/v1/agents/{agent}/conversations/{conversation}";agent.clear.path_params
Section titled “agent.clear.path_params”readonly path_params: readonly ["agent"];agent.clear.query
Section titled “agent.clear.query”readonly query: readonly [] = [];agent.clear.body
Section titled “agent.clear.body”readonly body: false = false;agent.calls
Section titled “agent.calls”readonly agent.calls: object;agent.calls.method
Section titled “agent.calls.method”readonly method: "GET" = "GET";agent.calls.path
Section titled “agent.calls.path”readonly path: "/v1/agents/{agent}/calls" = "/v1/agents/{agent}/calls";agent.calls.conversation
Section titled “agent.calls.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/calls" = "/v1/agents/{agent}/conversations/{conversation}/calls";agent.calls.path_params
Section titled “agent.calls.path_params”readonly path_params: readonly ["agent"];agent.calls.query
Section titled “agent.calls.query”readonly query: readonly [] = [];agent.calls.body
Section titled “agent.calls.body”readonly body: false = false;agent.calls.unwrap
Section titled “agent.calls.unwrap”readonly unwrap: "calls" = "calls";agent.kill
Section titled “agent.kill”readonly agent.kill: object;agent.kill.method
Section titled “agent.kill.method”readonly method: "DELETE" = "DELETE";agent.kill.path
Section titled “agent.kill.path”readonly path: "/v1/agents/{agent}/calls/{call}" = "/v1/agents/{agent}/calls/{call}";agent.kill.conversation
Section titled “agent.kill.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/calls/{call}" = "/v1/agents/{agent}/conversations/{conversation}/calls/{call}";agent.kill.path_params
Section titled “agent.kill.path_params”readonly path_params: readonly ["agent", "call"];agent.kill.query
Section titled “agent.kill.query”readonly query: readonly [] = [];agent.kill.body
Section titled “agent.kill.body”readonly body: false = false;agent.trigger_set
Section titled “agent.trigger_set”readonly agent.trigger_set: object;agent.trigger_set.method
Section titled “agent.trigger_set.method”readonly method: "PUT" = "PUT";agent.trigger_set.path
Section titled “agent.trigger_set.path”readonly path: "/v1/agents/{agent}/triggers/{trigger}" = "/v1/agents/{agent}/triggers/{trigger}";agent.trigger_set.path_params
Section titled “agent.trigger_set.path_params”readonly path_params: readonly ["agent", "trigger"];agent.trigger_set.query
Section titled “agent.trigger_set.query”readonly query: readonly [] = [];agent.trigger_set.body
Section titled “agent.trigger_set.body”readonly body: true = true;agent.trigger_remove
Section titled “agent.trigger_remove”readonly agent.trigger_remove: object;agent.trigger_remove.method
Section titled “agent.trigger_remove.method”readonly method: "DELETE" = "DELETE";agent.trigger_remove.path
Section titled “agent.trigger_remove.path”readonly path: "/v1/agents/{agent}/triggers/{trigger}" = "/v1/agents/{agent}/triggers/{trigger}";agent.trigger_remove.path_params
Section titled “agent.trigger_remove.path_params”readonly path_params: readonly ["agent", "trigger"];agent.trigger_remove.query
Section titled “agent.trigger_remove.query”readonly query: readonly [] = [];agent.trigger_remove.body
Section titled “agent.trigger_remove.body”readonly body: false = false;deployment.reload
Section titled “deployment.reload”readonly deployment.reload: object;deployment.reload.method
Section titled “deployment.reload.method”readonly method: "POST" = "POST";deployment.reload.path
Section titled “deployment.reload.path”readonly path: "/v1/deployment/reload" = "/v1/deployment/reload";deployment.reload.path_params
Section titled “deployment.reload.path_params”readonly path_params: readonly [] = [];deployment.reload.query
Section titled “deployment.reload.query”readonly query: readonly ["agents"];deployment.reload.body
Section titled “deployment.reload.body”readonly body: false = false;deployment.nodes
Section titled “deployment.nodes”readonly deployment.nodes: object;deployment.nodes.method
Section titled “deployment.nodes.method”readonly method: "GET" = "GET";deployment.nodes.path
Section titled “deployment.nodes.path”readonly path: "/v1/deployment/nodes" = "/v1/deployment/nodes";deployment.nodes.path_params
Section titled “deployment.nodes.path_params”readonly path_params: readonly [] = [];deployment.nodes.query
Section titled “deployment.nodes.query”readonly query: readonly [] = [];deployment.nodes.body
Section titled “deployment.nodes.body”readonly body: false = false;agent.move
Section titled “agent.move”readonly agent.move: object;agent.move.method
Section titled “agent.move.method”readonly method: "POST" = "POST";agent.move.path
Section titled “agent.move.path”readonly path: "/v1/agents/{agent}/move" = "/v1/agents/{agent}/move";agent.move.conversation
Section titled “agent.move.conversation”readonly conversation: "/v1/agents/{agent}/conversations/{conversation}/move" = "/v1/agents/{agent}/conversations/{conversation}/move";agent.move.path_params
Section titled “agent.move.path_params”readonly path_params: readonly ["agent"];agent.move.query
Section titled “agent.move.query”readonly query: readonly [] = [];agent.move.body
Section titled “agent.move.body”readonly body: true = true;agent.move.unwrap
Section titled “agent.move.unwrap”readonly unwrap: "agent" = "agent";