AgentDetails

pydantic model openapi_client.models.agent_details.AgentDetails

Details for a single AI agent in the GET /ai/agents list response.

Fields:

• access_type (str | None)

• agent_id (str | None)

• agent_name (str | None)

• agent_response_type (str | None)

• agent_status (str | None)

• agent_type (str | None)

• agent_version (str | None)

• cost_tags (List[openapi_client.models.list_agent_item_cost_tags_inner.ListAgentItemCostTagsInner] | None)

• created_by (str | None)

• creation_time (str | None)

• description (str | None)

• display_name (str | None)

• is_enabled (bool | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• model_id (str | None)

• usable_in_chat (bool | None)

field agent_id: Optional[StrictStr] = None (alias 'AgentId')

Unique identifier of the agent.

field agent_name: Optional[StrictStr] = None (alias 'AgentName')

Name of the agent.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Human-readable label for the agent in the UI. Optional on create; when omitted, AgentName is stored. Maximum 255 characters.

field agent_status: Optional[StrictStr] = None (alias 'AgentStatus')

Current status of the agent.

field description: Optional[StrictStr] = None (alias 'Description')

Description of the agent.

field agent_type: Optional[StrictStr] = None (alias 'AgentType')

Type of the agent (SYSTEM, CUSTOM, or MANAGED).

field agent_version: Optional[StrictStr] = None (alias 'AgentVersion')

Version of the agent.

field model_id: Optional[StrictStr] = None (alias 'ModelId')

ID of the AI model used by the agent.

field message: Optional[StrictStr] = None (alias 'Message')

Additional message or information about the agent.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Access type of the agent (owner, editor, or read-only).

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

ID of the user who created the agent.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Timestamp when the agent was created.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

ID of the user who last modified the agent.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Timestamp when the agent was last modified.

field is_enabled: Optional[StrictBool] = None (alias 'IsEnabled')

Indicates whether the agent is enabled.

field usable_in_chat: Optional[StrictBool] = None (alias 'UsableInChat')

Whether the agent can be used in chat. Defaults to true when omitted from stored metadata.

field agent_response_type: Optional[StrictStr] = None (alias 'AgentResponseType')

Agent response type (for example STREAM).

field cost_tags: Optional[List[ListAgentItemCostTagsInner]] = None (alias 'CostTags')

Cost tags associated with the agent when present in the listing projection.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of AgentDetails from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of AgentDetails from a dict

Return type:

Optional[Self]