Agent

This section groups API operations for managing agents, binding resources, invoking runs, automating work, and configuring the runtime. Open an action page for the required identifiers and call parameters.

Choose a task

Task

Page

Description

Manage agents and versions

Agent

The agent resource interface is used to manage agents, their versions and resources, models, operating strategies and operating environment bindings.

Choose an invocation protocol

Call the agent

Before calling an agent, obtain its Agent Card; then you can use the A2A or MCP protocol to initiate the call.

Manage sessions and read messages

session

The session interface is used to manage agent session shells and their presentation metadata.

Review run feedback

Agent feedback

The feedback interface is used to review saved agent running feedback and summary statistics; submitting feedback is still completed interactively during the agent runtime.

Configure and run automation tasks

Automate tasks

Automation tasks associate configured agents with triggering methods.

Prepare and confirm candidates

Agent building

The agent building interface is used to read creative resources, generate candidate solutions, and confirm or cancel candidate solutions.

Configure channel connections

Channel instance

A channel instance holds a connection configuration and credential reference for a specific Provider.

Configure agent models

Agent model configuration

The agent model configuration saves non-sensitive metadata such as model selections, capabilities, and connection references.

Configure runtime policies

Run policy configuration

The run policy configuration is the control plane metadata used by the agent when it is run.

Manage knowledge-base metadata

Agent knowledge base

List, retrieve, create, and update the knowledge bases attached to agents.

Manage tools and tool connections

Tools

The tool interface is used to manage workspace tools, query reference relationships, and manage built-in GitHub, Grafana, and email tool connections.

Manage skills and versions

Skills

The skills interface is used to manage workspace skills, import packages, select versions, and submit run requests.

Configure callback rules

Callback rules

List, retrieve, create, update, and delete callback rules.

Define node invocation templates

Agent task template

The agent task template describes the messages, inputs, and context configuration used by the workflow node when invoking the agent.

Bind workflow nodes to templates

Agent workflow binding

Agent workflow binding associates workflow nodes to an agent task template.

Choose a runtime provider

Runtime provider

List runtime providers and retrieve a provider profile.

Configure system agents

System agent configuration

Retrieve or update system agent configuration, including the available GitHub projects used by the configuration.

Load or export agent packages

Agent package

Load an agent package into the workspace or export an existing package.

Inspect runtime records

Observation when the agent is running

Inspect data partitions, runtime tasks, task events, manifests, and round snapshots for an agent run.

Track asynchronous resource operations

Agent resource operation

List and inspect agent resource operations, or cancel an operation that can be cancelled.

Connect external services

Agent connection

List, retrieve, create, and update agent connections, and probe MCP connections or create MCP tools in batches.

Last updated on