list_agents

AIApi.list_agents(role_id, limit=None, offset=None, sortorder=None, sortby=None, projection_expression=None, filter_expression=None, action=None, agent_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)[source]

List all ai agents user has access to

Returns a list of ai agents of which the user is owner or has viewer access

Parameters:

  • role_id (str) – (required)

  • limit (str)

  • offset (str)

  • sortorder (str)

  • sortby (str)

  • projection_expression (str)

  • filter_expression (str)

  • action (str)

  • agent_id (str) – Optional agent ID. Used with action=generate_presigned_url for script updates. If not provided, a new UUID will be generated for new agent creation

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListAgentsResponse

Returns:

Returns the result object.