InvokeAgentResponsesApiRoutineAction interface

Package:

@azure/ai-projects

Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.

Extends

RoutineAction

Properties

agent_endpoint_id	Legacy endpoint-scoped agent identifier for routine dispatch.
agent_name	The project-scoped agent name for routine dispatch.
conversation	An optional existing conversation identifier to continue during the downstream dispatch.
input	Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied.
type	The action type.

Property Details

agent_endpoint_id

Legacy endpoint-scoped agent identifier for routine dispatch.

agent_endpoint_id?: string

Property Value

string

agent_name

The project-scoped agent name for routine dispatch.

agent_name?: string

Property Value

string

conversation

An optional existing conversation identifier to continue during the downstream dispatch.

conversation?: string

Property Value

string

input

Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied.

input?: any

Property Value

any

type

The action type.

type: "invoke_agent_responses_api"

Property Value

"invoke_agent_responses_api"