ListAgentsResponse

class openapi_client.models.list_agents_response.ListAgentsResponse(**data)

Bases: BaseModel

Response for GET /ai/agents endpoint. Structure varies based on query parameters. See endpoint description for details.

agents: Optional[List[AgentDetails]]

message: Optional[Annotated[str, Field(strict=True)]]

presigned_url: Optional[Annotated[str, Field(strict=True)]]

agent_id: Optional[Annotated[str, Field(strict=True)]]

utility_tool: Optional[Annotated[str, Field(strict=True)]]

http_tool: Optional[Annotated[str, Field(strict=True)]]

processor_tool: Optional[Annotated[str, Field(strict=True)]]

count: Optional[StrictInt]

total_count: Optional[StrictInt]

next_available: Optional[StrictStr]

classmethod message_validate_regular_expression(value)

Validates the regular expression

classmethod presigned_url_validate_regular_expression(value)

Validates the regular expression

classmethod agent_id_validate_regular_expression(value)

Validates the regular expression

classmethod utility_tool_validate_regular_expression(value)

Validates the regular expression

classmethod http_tool_validate_regular_expression(value)

Validates the regular expression

classmethod processor_tool_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

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 ListAgentsResponse 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 ListAgentsResponse from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'agent_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentId', alias_priority=2, description='ID of the created agent'), 'agents': FieldInfo(annotation=Union[List[AgentDetails], NoneType], required=False), 'count': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Number of agents in current page (present when no action parameter)'), 'http_tool': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='httpTool', alias_priority=2, description='Output for action=get_sample_templates: a JSON object where keys are template filenames and values are the script contents.'), 'message': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='Message', alias_priority=2, description='Status message from the API.'), 'next_available': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Whether more pages are available (present when no action parameter)'), 'presigned_url': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='PresignedUrl', alias_priority=2, description='Generated presigned URL (present when action=generate_presigned_url)'), 'processor_tool': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='processorTool', alias_priority=2, description='Output for action=get_sample_templates: a JSON object where keys are template filenames and values are the script contents.'), 'total_count': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Total number of agents available (present when no action parameter)'), 'utility_tool': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='utilityTool', alias_priority=2, description='Output for action=get_sample_templates: a JSON object where keys are template filenames and values are the script contents.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• __context (Any) – The context.

Return type:

None