Request
Path parameters
string
required
The unique identifier of the published agent to invoke (e.g.
"stripe-agent").Body parameters
object
Structured input payload forwarded to the agent. Defaults to
null if omitted.string
Natural language instruction for the agent.
string
Optional A2A task identifier. Allows you to correlate this invocation with an existing task.
string
Optional A2A context identifier for multi-turn conversation state.
string
Identifier of the specific agent skill to invoke. Omit to let the agent select the appropriate skill.
string
Bearer token or API key passed directly to the agent. Use
auth_context_id instead to reference a stored credential.string (UUID)
Reference to a stored auth context. The gateway decrypts and forwards the credential without exposing it in the request log.
string
ISO country code of the calling region (e.g.
"AU"). The gateway enforces this against the agent’s allowed_regions policy.boolean
Set to
true to acknowledge and proceed with agents flagged as requiring human approval (human_approval_required: true). Defaults to false.integer
Maximum cost units you are willing to spend. The gateway rejects the call if the agent’s
cost_per_call_units exceeds this value.object
Optional payment settlement request forwarded to the agent.
object
Raw A2A envelope to forward verbatim to the agent. Use this to pass protocol-specific fields not covered by the other parameters.
Response
Returns anInvokeAgentResponse on success.
string
The agent that was invoked.
string
Execution status reported by the gateway (e.g.
"completed", "failed").string (UUID)
Unique identifier for the execution receipt persisted by the gateway. Use this to retrieve the receipt later.
string
A2A task identifier returned by the agent. Omitted if the agent does not return one.
string
A2A context identifier. Omitted if not present.
string
Human-readable status message. Omitted if not present.
object
Structured output from the agent. Omitted if the agent returns no structured data.
object
Normalized settlement request echoed back from the gateway. Omitted if no settlement was requested.
object
Payment receipt from the settlement rail. Omitted if no payment occurred.
object
The raw A2A JSON-RPC response returned by the agent endpoint.