--- title: "List Agents" method: GET path: "/v2/gen-ai/agents" tags: ["DigitalOcean-public.v2-new_GradientAI Platform"] --- # List Agents `GET /v2/gen-ai/agents` To list all agents, send a GET request to `/v2/gen-ai/agents`. ## Query parameters - `only_deployed` boolean - `page` integer - `per_page` integer ## Response `200` A successful response. - ApiListAgentsOutputPublic — List of Agents - `agents` ApiAgentPublic[] — Agents - `chatbot` ApiChatbot — A Chatbot - `button_background_color` string - `logo` string - `name` string — Name of chatbot - `primary_color` string - `secondary_color` string - `starting_message` string - `chatbot_identifiers` ApiAgentChatbotIdentifier[] — Chatbot identifiers - `agent_chatbot_identifier` string — Agent chatbot identifier - `created_at` string, date-time — Creation date / time - `deployment` ApiDeployment — Description of deployment - `created_at` string, date-time — Creation date / time - `name` string — Name - `status` '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, date-time — Last modified - `url` string — Access your deployed agent here - `uuid` string — Unique id - `visibility` 'VISIBILITY_UNKNOWN' | 'VISIBILITY_DISABLED' | 'VISIBILITY_PLAYGROUND' | 'VISIBILITY_PUBLIC' | 'VISIBILITY_PRIVATE' — - 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` integer — How many results should be considered from an attached knowledge base - `max_tokens` integer — 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` ApiModel — Description of a Model - `agreement` ApiAgreement — Agreement Description - `description` string - `name` string - `url` string - `uuid` string - `created_at` string, date-time — Creation date / time - `inference_name` string — Internally used name - `inference_version` string — Internally used version - `is_foundational` boolean — True if it is a foundational model provided by do - `metadata` object — Additional meta data - `name` string — Name of the model - `parent_uuid` string — Unique id of the model, this model is based on - `provider` 'MODEL_PROVIDER_DIGITALOCEAN' | 'MODEL_PROVIDER_ANTHROPIC' | 'MODEL_PROVIDER_OPENAI' - `updated_at` string, date-time — Last modified - `upload_complete` boolean — Model has been fully uploaded - `url` string — Download url - `usecases` ApiModelUsecase[] — Usecases of the model - `uuid` string — Unique id - `version` ApiModelVersion — Version Information about a Model - `major` integer — Major version number - `minor` integer — Minor version number - `patch` integer — Patch version number - `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` 'RETRIEVAL_METHOD_UNKNOWN' | 'RETRIEVAL_METHOD_REWRITE' | 'RETRIEVAL_METHOD_STEP_BACK' | 'RETRIEVAL_METHOD_SUB_QUERIES' | 'RETRIEVAL_METHOD_NONE' — - 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, date-time — Creation of route date / time - `route_created_by` string, uint64 — Id of user that created the route - `route_name` string — Route name - `route_uuid` string — Route uuid - `tags` string[] — A set of abitrary tags to organize your agent - `temperature` number, 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` ApiAgentTemplate — Represents an AgentTemplate entity - `created_at` string, date-time — The agent template's creation date - `description` string — Deprecated - Use summary instead - `guardrails` ApiAgentTemplateGuardrail[] — List of guardrails associated with the agent template - `priority` integer — Priority of the guardrail - `uuid` string — Uuid of the guardrail - `instruction` string — Instructions for the agent template - `k` integer — The 'k' value for the agent template - `knowledge_bases` ApiKnowledgeBase[] — List of knowledge bases associated with the agent template - `added_to_agent_at` string, date-time — Time when the knowledge base was added to the agent - `created_at` string, date-time — Creation date / time - `database_id` string - `embedding_model_uuid` string - `is_public` boolean — Whether the knowledge base is public or not - `last_indexing_job` ApiIndexingJob — IndexingJob description - `completed_datasources` integer — Number of datasources indexed completed - `created_at` string, date-time — Creation date / time - `data_source_uuids` string[] - `finished_at` string, date-time - `knowledge_base_uuid` string — Knowledge base id - `phase` 'BATCH_JOB_PHASE_UNKNOWN' | 'BATCH_JOB_PHASE_PENDING' | 'BATCH_JOB_PHASE_RUNNING' | 'BATCH_JOB_PHASE_SUCCEEDED' | 'BATCH_JOB_PHASE_FAILED' | 'BATCH_JOB_PHASE_ERROR' | 'BATCH_JOB_PHASE_CANCELLED' - `started_at` string, date-time - `status` 'INDEX_JOB_STATUS_UNKNOWN' | 'INDEX_JOB_STATUS_PARTIAL' | 'INDEX_JOB_STATUS_IN_PROGRESS' | 'INDEX_JOB_STATUS_COMPLETED' | 'INDEX_JOB_STATUS_FAILED' | 'INDEX_JOB_STATUS_NO_CHANGES' | 'INDEX_JOB_STATUS_PENDING' - `tokens` integer — Number of tokens - `total_datasources` integer — Number of datasources being indexed - `total_items_failed` string, uint64 — Total Items Failed - `total_items_indexed` string, uint64 — Total Items Indexed - `total_items_skipped` string, uint64 — Total Items Skipped - `updated_at` string, date-time — Last modified - `uuid` string — Unique id - `name` string — Name of knowledge base - `project_id` string - `region` string — Region code - `tags` string[] — Tags to organize related resources - `updated_at` string, date-time — Last modified - `user_id` string, int64 — Id of user that created the knowledge base - `uuid` string — Unique id for knowledge base - `long_description` string — The long description of the agent template - `max_tokens` integer — The max_tokens setting for the agent template - `model` ApiModel — Description of a Model - `agreement` ApiAgreement — Agreement Description - `description` string - `name` string - `url` string - `uuid` string - `created_at` string, date-time — Creation date / time - `inference_name` string — Internally used name - `inference_version` string — Internally used version - `is_foundational` boolean — True if it is a foundational model provided by do - `metadata` object — Additional meta data - `name` string — Name of the model - `parent_uuid` string — Unique id of the model, this model is based on - `provider` 'MODEL_PROVIDER_DIGITALOCEAN' | 'MODEL_PROVIDER_ANTHROPIC' | 'MODEL_PROVIDER_OPENAI' - `updated_at` string, date-time — Last modified - `upload_complete` boolean — Model has been fully uploaded - `url` string — Download url - `usecases` ApiModelUsecase[] — Usecases of the model - `uuid` string — Unique id - `version` ApiModelVersion — Version Information about a Model - `major` integer — Major version number - `minor` integer — Minor version number - `patch` integer — Patch version number - `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` string[] — List of tags associated with the agent template - `temperature` number, float — The temperature setting for the agent template - `template_type` '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 - `top_p` number, float — The top_p setting for the agent template - `updated_at` string, date-time — The agent template's last updated date - `uuid` string — Unique id - `top_p` number, 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` string, date-time — Last modified - `url` string — Access your agent under this url - `user_id` string, uint64 — 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 - `pages` ApiPages — Information about how to reach other pages - `first` string — First page - `last` string — Last page - `next` string — Next page - `previous` string — Previous page - `meta` ApiMeta — Meta information about the data set - `page` integer — The current page - `pages` integer — Total number of pages - `total` integer — Total amount of items over all pages ## Other responses - `401` — Authentication failed due to invalid credentials. - `404` — The resource was not found. - `429` — The API rate limit has been exceeded. - `500` — There was a server error. - `default` — There was an unexpected error. --- [API](https://skmtc.net/digitalocean/apis/digitalocean-api.md) · [All operations](https://skmtc.net/digitalocean/apis/digitalocean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalocean/digitalocean-api/revisions/cb3bf9b21459/schema)