Skip to content

Integrations

A2A

Interact with external A2A-compatible agents

Use the A2A (Agent-to-Agent) protocol to send messages, structured data, and files to external agents, inspect their Agent Cards, and track or cancel tasks. Provide the agent's endpoint URL and, when required, an API key. Sim sends that key in X-API-Key for task requests; agents that require a different authentication scheme need a compatible endpoint. Agent Card discovery runs before authentication, so the card must be reachable without that key.

Actions

A2A Send Message

Send a message to an external A2A agent and return its response.

Input

ParameterTypeRequiredDescription
agentUrlstringYesThe A2A agent endpoint URL
messagestringYesThe message text to send
datajsonNoStructured JSON data to attach
filesarrayNoFiles to attach, uploaded or referenced from a previous block
taskIdstringNoExisting task ID to continue
contextIdstringNoConversation context ID to continue
apiKeystringNoAPI key for authentication (if required)

Output

ParameterTypeDescription
contentstringAgent response text
taskIdstringTask identifier
contextIdstringConversation/context identifier
statestringTask lifecycle state: submitted, working, input-required, auth-required, completed, failed, canceled, or rejected
artifactsarrayStructured task output artifacts

A2A Get Task

Retrieve the current state and result of an A2A task.

Input

ParameterTypeRequiredDescription
agentUrlstringYesThe A2A agent endpoint URL
taskIdstringYesThe task ID to retrieve
historyLengthnumberNoMaximum number of history messages to include
apiKeystringNoAPI key for authentication (if required)

Output

ParameterTypeDescription
contentstringAgent response text
taskIdstringTask identifier
contextIdstringConversation/context identifier
statestringTask lifecycle state
artifactsarrayStructured task output artifacts

A2A Cancel Task

Request cancellation of an in-progress A2A task.

Input

ParameterTypeRequiredDescription
agentUrlstringYesThe A2A agent endpoint URL
taskIdstringYesThe task ID to cancel
apiKeystringNoAPI key for authentication (if required)

Output

ParameterTypeDescription
taskIdstringTask identifier
statestringTask lifecycle state after cancellation
canceledbooleanWhether the task reached the canceled state

A2A Get Agent Card

Fetch the Agent Card (discovery document) for an external A2A agent.

Input

ParameterTypeRequiredDescription
agentUrlstringYesThe A2A agent endpoint URL
apiKeystringNoAPI key for authentication (if required)

Output

ParameterTypeDescription
namestringAgent display name
descriptionstringAgent description
urlstringAgent endpoint URL
versionstringThe agent's own version
protocolVersionstringA2A protocol version the agent exposes
capabilitiesjsonAgent capability flags
skillsarraySkills the agent can perform
defaultInputModesarrayDefault accepted input media types
defaultOutputModesarrayDefault produced output media types

Task behavior and limits

  • A2A Send Message requests blocking execution until the agent reaches a terminal (completed, failed, canceled, rejected) or interrupted (input-required, auth-required) state. Use A2A Get Task to poll a task you continue later, and branch on state.
  • Sim limits each agent HTTP response to 10 MiB, each Agent Card discovery HTTP request to 30 seconds, and task RPC requests to 300 seconds. Discovery tries up to three candidate paths. A blocking request can time out before the remote task completes; use its task ID to check the remote state before retrying.
  • Task IDs are scoped to the external agent, not to Sim. Anyone who knows an agent URL and task ID can read or cancel that task unless the agent enforces its own authentication — set an API key for agents that require one.
Was this helpful?
Suggest an edit