Skip to content

get_agent

Operation

get_agent

get_agent(request: GetAgentInput | GetAgentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentInputDict]) -> GetAgentOutput

Gets information about an agent.

Parameters:

Name Type Description Default
request GetAgentInput | GetAgentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAgentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentOutput

An instance of GetAgentOutput.

get_agent async

get_agent(request: GetAgentInput | GetAgentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentInputDict]) -> GetAgentOutput

Gets information about an agent.

Parameters:

Name Type Description Default
request GetAgentInput | GetAgentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAgentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentOutput

An instance of GetAgentOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAgentInputDict

Bases: TypedDict

Dictionary form of GetAgentInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent.

GetAgentInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentInput structure.

Attributes

agent_id class-attribute instance-attribute
agent_id: str | None = ...

The unique identifier of the agent.

Output

GetAgentOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentOutput structure.

Attributes

agent instance-attribute
agent: Agent

Contains details about the agent.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.