## List `agents.list(AgentListParams**kwargs) -> AgentListResponse` **get** `/v2/gen-ai/agents` To list all agents, send a GET request to `/v2/gen-ai/agents`. ### Parameters - **only\_deployed:** `bool` Only list agents that are deployed. - **page:** `int` Page number. - **per\_page:** `int` Items per page. ### Returns - `class AgentListResponse` List of Agents - **agents:** `Optional[List[Agent]]` Agents - **chatbot:** `Optional[AgentChatbot]` A Chatbot - **button\_background\_color:** `Optional[str]` - **logo:** `Optional[str]` - **name:** `Optional[str]` Name of chatbot - **primary\_color:** `Optional[str]` - **secondary\_color:** `Optional[str]` - **starting\_message:** `Optional[str]` - **chatbot\_identifiers:** `Optional[List[AgentChatbotIdentifier]]` Chatbot identifiers - **agent\_chatbot\_identifier:** `Optional[str]` Agent chatbot identifier - **created\_at:** `Optional[datetime]` Creation date / time - **deployment:** `Optional[AgentDeployment]` Description of deployment - **created\_at:** `Optional[datetime]` Creation date / time - **name:** `Optional[str]` Name - **status:** `Optional[Literal["STATUS_UNKNOWN", "STATUS_WAITING_FOR_DEPLOYMENT", "STATUS_DEPLOYING", 6 more]]` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - **updated\_at:** `Optional[datetime]` Last modified - **url:** `Optional[str]` Access your deployed agent here - **uuid:** `Optional[str]` Unique id - **visibility:** `Optional[APIDeploymentVisibility]` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - **description:** `Optional[str]` Description of agent - **if\_case:** `Optional[str]` Instructions to the agent on how to use the route - **instruction:** `Optional[str]` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - **k:** `Optional[int]` How many results should be considered from an attached knowledge base - **max\_tokens:** `Optional[int]` Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. - **model:** `Optional[APIAgentModel]` Description of a Model - **name:** `Optional[str]` Agent name - **project\_id:** `Optional[str]` The DigitalOcean project ID associated with the agent - **provide\_citations:** `Optional[bool]` Whether the agent should provide in-response citations - **region:** `Optional[str]` Region code - **retrieval\_method:** `Optional[APIRetrievalMethod]` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - **route\_created\_at:** `Optional[datetime]` Creation of route date / time - **route\_created\_by:** `Optional[str]` Id of user that created the route - **route\_name:** `Optional[str]` Route name - **route\_uuid:** `Optional[str]` Route uuid - **tags:** `Optional[List[str]]` A set of abitrary tags to organize your agent - **temperature:** `Optional[float]` Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. - **template:** `Optional[AgentTemplate]` Represents an AgentTemplate entity - **created\_at:** `Optional[datetime]` The agent template's creation date - **description:** `Optional[str]` Deprecated - Use summary instead - **guardrails:** `Optional[List[AgentTemplateGuardrail]]` List of guardrails associated with the agent template - **priority:** `Optional[int]` Priority of the guardrail - **uuid:** `Optional[str]` Uuid of the guardrail - **instruction:** `Optional[str]` Instructions for the agent template - **k:** `Optional[int]` The 'k' value for the agent template - **knowledge\_bases:** `Optional[List[APIKnowledgeBase]]` List of knowledge bases associated with the agent template - **added\_to\_agent\_at:** `Optional[datetime]` Time when the knowledge base was added to the agent - **created\_at:** `Optional[datetime]` Creation date / time - **database\_id:** `Optional[str]` - **embedding\_model\_uuid:** `Optional[str]` - **is\_public:** `Optional[bool]` Whether the knowledge base is public or not - **last\_indexing\_job:** `Optional[APIIndexingJob]` IndexingJob description - **name:** `Optional[str]` Name of knowledge base - **project\_id:** `Optional[str]` - **region:** `Optional[str]` Region code - **tags:** `Optional[List[str]]` Tags to organize related resources - **updated\_at:** `Optional[datetime]` Last modified - **user\_id:** `Optional[str]` Id of user that created the knowledge base - **uuid:** `Optional[str]` Unique id for knowledge base - **long\_description:** `Optional[str]` The long description of the agent template - **max\_tokens:** `Optional[int]` The max_tokens setting for the agent template - **model:** `Optional[APIAgentModel]` Description of a Model - **name:** `Optional[str]` Name of the agent template - **short\_description:** `Optional[str]` The short description of the agent template - **summary:** `Optional[str]` The summary of the agent template - **tags:** `Optional[List[str]]` List of tags associated with the agent template - **temperature:** `Optional[float]` The temperature setting for the agent template - **template\_type:** `Optional[Literal["AGENT_TEMPLATE_TYPE_STANDARD", "AGENT_TEMPLATE_TYPE_ONE_CLICK"]]` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - **top\_p:** `Optional[float]` The top_p setting for the agent template - **updated\_at:** `Optional[datetime]` The agent template's last updated date - **uuid:** `Optional[str]` Unique id - **top\_p:** `Optional[float]` Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. - **updated\_at:** `Optional[datetime]` Last modified - **url:** `Optional[str]` Access your agent under this url - **user\_id:** `Optional[str]` Id of user that created the agent - **uuid:** `Optional[str]` Unique agent id - **version\_hash:** `Optional[str]` The latest version of the agent - **links:** `Optional[APILinks]` Links to other pages - **meta:** `Optional[APIMeta]` Meta information about the data set ### Example ```python from do_gradientai import GradientAI client = GradientAI() agents = client.agents.list() print(agents.agents) ```