## List

**get** `/v2/gen-ai/agents`

To list all agents, send a GET request to `/v2/gen-ai/agents`.

### Returns

- **agents:** `array of object`

  Agents

  - **chatbot:** `object`

    A Chatbot

    - **button\_background\_color:** `string`

    - **logo:** `string`

    - **name:** `string`

      Name of chatbot

    - **primary\_color:** `string`

    - **secondary\_color:** `string`

    - **starting\_message:** `string`

  - **chatbot\_identifiers:** `array of object`

    Chatbot identifiers

    - **agent\_chatbot\_identifier:** `string`

      Agent chatbot identifier

  - **created\_at:** `string`

    Creation date / time

  - **deployment:** `object`

    Description of deployment

    - **created\_at:** `string`

      Creation date / time

    - **name:** `string`

      Name

    - **status:** `"STATUS_UNKNOWN" OR "STATUS_WAITING_FOR_DEPLOYMENT" OR "STATUS_DEPLOYING" OR 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:** `string`

      Last modified

    - **url:** `string`

      Access your deployed agent here

    - **uuid:** `string`

      Unique id

    - **visibility:** `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:** `string`

    Description of agent

  - **if\_case:** `string`

    Instructions to the agent on how to use the route

  - **instruction:** `string`

    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:** `number`

    How many results should be considered from an attached knowledge base

  - **max\_tokens:** `number`

    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:** `APIAgentModel`

    Description of a Model

  - **name:** `string`

    Agent name

  - **project\_id:** `string`

    The DigitalOcean project ID associated with the agent

  - **provide\_citations:** `boolean`

    Whether the agent should provide in-response citations

  - **region:** `string`

    Region code

  - **retrieval\_method:** `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:** `string`

    Creation of route date / time

  - **route\_created\_by:** `string`

    Id of user that created the route

  - **route\_name:** `string`

    Route name

  - **route\_uuid:** `string`

    Route uuid

  - **tags:** `array of string`

    A set of abitrary tags to organize your agent

  - **temperature:** `number`

    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:** `object`

    Represents an AgentTemplate entity

    - **created\_at:** `string`

      The agent template's creation date

    - **description:** `string`

      Deprecated - Use summary instead

    - **guardrails:** `array of object`

      List of guardrails associated with the agent template

      - **priority:** `number`

        Priority of the guardrail

      - **uuid:** `string`

        Uuid of the guardrail

    - **instruction:** `string`

      Instructions for the agent template

    - **k:** `number`

      The 'k' value for the agent template

    - **knowledge\_bases:** `array of APIKnowledgeBase`

      List of knowledge bases associated with the agent template

    - **long\_description:** `string`

      The long description of the agent template

    - **max\_tokens:** `number`

      The max_tokens setting for the agent template

    - **model:** `APIAgentModel`

      Description of a Model

    - **name:** `string`

      Name of the agent template

    - **short\_description:** `string`

      The short description of the agent template

    - **summary:** `string`

      The summary of the agent template

    - **tags:** `array of string`

      List of tags associated with the agent template

    - **temperature:** `number`

      The temperature setting for the agent template

    - **template\_type:** `"AGENT_TEMPLATE_TYPE_STANDARD" OR "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:** `number`

      The top_p setting for the agent template

    - **updated\_at:** `string`

      The agent template's last updated date

    - **uuid:** `string`

      Unique id

  - **top\_p:** `number`

    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:** `string`

    Last modified

  - **url:** `string`

    Access your agent under this url

  - **user\_id:** `string`

    Id of user that created the agent

  - **uuid:** `string`

    Unique agent id

  - **version\_hash:** `string`

    The latest version of the agent

- **links:** `APILinks`

  Links to other pages

- **meta:** `APIMeta`

  Meta information about the data set