Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List Agents

API Reference
Agents
Evaluation Metrics
OpenAI
Keys
List agents by OpenAI key
agents.evaluation_metrics.openai.keys.list_agents(struuid, KeyListAgentsParams**kwargs) -> KeyListAgentsResponse
get/v2/gen-ai/openai/keys/{uuid}/agents

List Agents by OpenAI Key.

ParametersExpand Collapse
uuid: str
page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse
class KeyListAgentsResponse: …

List of Agents that are linked to a specific OpenAI Key

agents: Optional[List[APIAgent]]
anthropic_api_key: Optional[APIAnthropicAPIKeyInfo]

Anthropic API Key Info

created_at: Optional[datetime]

Key creation date

formatdate-time
created_by: Optional[str]

Created by user id from DO

formatuint64
deleted_at: Optional[datetime]

Key deleted date

formatdate-time
name: Optional[str]

Name

updated_at: Optional[datetime]

Key last updated date

formatdate-time
uuid: Optional[str]

Uuid

api_key_infos: Optional[List[APIAgentAPIKeyInfo]]

Api key infos

created_at: Optional[datetime]

Creation date

formatdate-time
created_by: Optional[str]

Created by

formatuint64
deleted_at: Optional[datetime]

Deleted date

formatdate-time
name: Optional[str]

Name

secret_key: Optional[str]
uuid: Optional[str]

Uuid

api_keys: Optional[List[APIKey]]

Api keys

api_key: Optional[str]

Api key

chatbot: Optional[Chatbot]

A Chatbot

button_background_color: Optional[str]
name: Optional[str]

Name of chatbot

primary_color: Optional[str]
secondary_color: Optional[str]
starting_message: Optional[str]
chatbot_identifiers: Optional[List[ChatbotIdentifier]]

Chatbot identifiers

agent_chatbot_identifier: Optional[str]

Agent chatbot identifier

child_agents: Optional[List[APIAgent]]

Child agents

conversation_logs_enabled: Optional[bool]

Whether conversation logs are enabled for the agent

created_at: Optional[datetime]

Creation date / time

formatdate-time
deployment: Optional[Deployment]

Description of deployment

created_at: Optional[datetime]

Creation date / time

formatdate-time
name: Optional[str]

Name

status: Optional[Literal["STATUS_UNKNOWN", "STATUS_WAITING_FOR_DEPLOYMENT", "STATUS_DEPLOYING", 6 more]]
Accepts one of the following:
"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

formatdate-time
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
Accepts one of the following:
"VISIBILITY_UNKNOWN"
"VISIBILITY_DISABLED"
"VISIBILITY_PLAYGROUND"
"VISIBILITY_PUBLIC"
"VISIBILITY_PRIVATE"
description: Optional[str]

Description of agent

functions: Optional[List[Function]]
api_key: Optional[str]

Api key

created_at: Optional[datetime]

Creation date / time

formatdate-time
created_by: Optional[str]

Created by user id from DO

formatuint64
description: Optional[str]

Agent description

faas_name: Optional[str]
faas_namespace: Optional[str]
input_schema: Optional[object]
name: Optional[str]

Name

output_schema: Optional[object]
updated_at: Optional[datetime]

Last modified

formatdate-time
url: Optional[str]

Download your agent here

uuid: Optional[str]

Unique id

guardrails: Optional[List[Guardrail]]

The guardrails the agent is attached to

agent_uuid: Optional[str]
created_at: Optional[datetime]
default_response: Optional[str]
description: Optional[str]
guardrail_uuid: Optional[str]
is_attached: Optional[bool]
is_default: Optional[bool]
metadata: Optional[object]
name: Optional[str]
priority: Optional[int]
type: Optional[Literal["GUARDRAIL_TYPE_UNKNOWN", "GUARDRAIL_TYPE_JAILBREAK", "GUARDRAIL_TYPE_SENSITIVE_DATA", "GUARDRAIL_TYPE_CONTENT_MODERATION"]]
Accepts one of the following:
"GUARDRAIL_TYPE_UNKNOWN"
"GUARDRAIL_TYPE_JAILBREAK"
"GUARDRAIL_TYPE_SENSITIVE_DATA"
"GUARDRAIL_TYPE_CONTENT_MODERATION"
updated_at: Optional[datetime]
uuid: Optional[str]
if_case: Optional[str]
instruction: Optional[str]

Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices.

k: Optional[int]
knowledge_bases: Optional[List[APIKnowledgeBase]]

Knowledge bases

added_to_agent_at: Optional[datetime]

Time when the knowledge base was added to the agent

formatdate-time
created_at: Optional[datetime]

Creation date / time

formatdate-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

completed_datasources: Optional[int]

Number of datasources indexed completed

formatint64
created_at: Optional[datetime]

Creation date / time

formatdate-time
data_source_uuids: Optional[List[str]]
finished_at: Optional[datetime]
knowledge_base_uuid: Optional[str]

Knowledge base id

phase: Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 4 more]]
Accepts one of the following:
"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: Optional[datetime]
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
Accepts one of the following:
"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: Optional[int]

Number of tokens

formatint64
total_datasources: Optional[int]

Number of datasources being indexed

formatint64
total_items_failed: Optional[str]

Total Items Failed

formatuint64
total_items_indexed: Optional[str]

Total Items Indexed

formatuint64
total_items_skipped: Optional[str]

Total Items Skipped

formatuint64
updated_at: Optional[datetime]

Last modified

formatdate-time
uuid: Optional[str]

Unique id

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

formatdate-time
user_id: Optional[str]

Id of user that created the knowledge base

formatint64
uuid: Optional[str]

Unique id for knowledge base

logging_config: Optional[LoggingConfig]
galileo_project_id: Optional[str]

Galileo project identifier

galileo_project_name: Optional[str]

Name of the Galileo project

insights_enabled: Optional[bool]

Whether insights are enabled

insights_enabled_at: Optional[datetime]

Timestamp when insights were enabled

formatdate-time
log_stream_id: Optional[str]

Identifier for the log stream

log_stream_name: Optional[str]

Name of the log stream

max_tokens: Optional[int]
model: Optional[APIAgentModel]

Description of a Model

agreement: Optional[APIAgreement]

Agreement Description

description: Optional[str]
name: Optional[str]
url: Optional[str]
uuid: Optional[str]
created_at: Optional[datetime]

Creation date / time

formatdate-time
inference_name: Optional[str]

Internally used name

inference_version: Optional[str]

Internally used version

is_foundational: Optional[bool]

True if it is a foundational model provided by do

metadata: Optional[object]

Additional meta data

name: Optional[str]

Name of the model

parent_uuid: Optional[str]

Unique id of the model, this model is based on

provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at: Optional[datetime]

Last modified

formatdate-time
upload_complete: Optional[bool]

Model has been fully uploaded

url: Optional[str]

Download url

usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]

Usecases of the model

Accepts one of the following:
"MODEL_USECASE_UNKNOWN"
"MODEL_USECASE_AGENT"
"MODEL_USECASE_FINETUNED"
"MODEL_USECASE_KNOWLEDGEBASE"
"MODEL_USECASE_GUARDRAIL"
"MODEL_USECASE_REASONING"
"MODEL_USECASE_SERVERLESS"
uuid: Optional[str]

Unique id

version: Optional[APIModelVersion]

Version Information about a Model

major: Optional[int]

Major version number

formatint64
minor: Optional[int]

Minor version number

formatint64
patch: Optional[int]

Patch version number

formatint64
name: Optional[str]

Agent name

openai_api_key: Optional[APIOpenAIAPIKeyInfo]

OpenAI API Key Info

created_at: Optional[datetime]

Key creation date

formatdate-time
created_by: Optional[str]

Created by user id from DO

formatuint64
deleted_at: Optional[datetime]

Key deleted date

formatdate-time
models: Optional[List[APIAgentModel]]

Models supported by the openAI api key

agreement: Optional[APIAgreement]

Agreement Description

description: Optional[str]
name: Optional[str]
url: Optional[str]
uuid: Optional[str]
created_at: Optional[datetime]

Creation date / time

formatdate-time
inference_name: Optional[str]

Internally used name

inference_version: Optional[str]

Internally used version

is_foundational: Optional[bool]

True if it is a foundational model provided by do

metadata: Optional[object]

Additional meta data

name: Optional[str]

Name of the model

parent_uuid: Optional[str]

Unique id of the model, this model is based on

provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at: Optional[datetime]

Last modified

formatdate-time
upload_complete: Optional[bool]

Model has been fully uploaded

url: Optional[str]

Download url

usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]

Usecases of the model

Accepts one of the following:
"MODEL_USECASE_UNKNOWN"
"MODEL_USECASE_AGENT"
"MODEL_USECASE_FINETUNED"
"MODEL_USECASE_KNOWLEDGEBASE"
"MODEL_USECASE_GUARDRAIL"
"MODEL_USECASE_REASONING"
"MODEL_USECASE_SERVERLESS"
uuid: Optional[str]

Unique id

version: Optional[APIModelVersion]

Version Information about a Model

major: Optional[int]

Major version number

formatint64
minor: Optional[int]

Minor version number

formatint64
patch: Optional[int]

Patch version number

formatint64
name: Optional[str]

Name

updated_at: Optional[datetime]

Key last updated date

formatdate-time
uuid: Optional[str]

Uuid

parent_agents: Optional[List[APIAgent]]

Parent agents

project_id: Optional[str]
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
Accepts one of the following:
"RETRIEVAL_METHOD_UNKNOWN"
"RETRIEVAL_METHOD_REWRITE"
"RETRIEVAL_METHOD_STEP_BACK"
"RETRIEVAL_METHOD_SUB_QUERIES"
"RETRIEVAL_METHOD_NONE"
route_created_at: Optional[datetime]

Creation of route date / time

formatdate-time
route_created_by: Optional[str]
route_name: Optional[str]

Route name

route_uuid: Optional[str]
tags: Optional[List[str]]

Agent tag to organize related resources

temperature: Optional[float]
template: Optional[Template]

Represents an AgentTemplate entity

created_at: Optional[datetime]

The agent template's creation date

formatdate-time
description: Optional[str]

Deprecated - Use summary instead

guardrails: Optional[List[TemplateGuardrail]]

List of guardrails associated with the agent template

priority: Optional[int]

Priority of the guardrail

formatint32
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

formatint64
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

formatdate-time
created_at: Optional[datetime]

Creation date / time

formatdate-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

completed_datasources: Optional[int]

Number of datasources indexed completed

formatint64
created_at: Optional[datetime]

Creation date / time

formatdate-time
data_source_uuids: Optional[List[str]]
finished_at: Optional[datetime]
knowledge_base_uuid: Optional[str]

Knowledge base id

phase: Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 4 more]]
Accepts one of the following:
"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: Optional[datetime]
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
Accepts one of the following:
"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: Optional[int]

Number of tokens

formatint64
total_datasources: Optional[int]

Number of datasources being indexed

formatint64
total_items_failed: Optional[str]

Total Items Failed

formatuint64
total_items_indexed: Optional[str]

Total Items Indexed

formatuint64
total_items_skipped: Optional[str]

Total Items Skipped

formatuint64
updated_at: Optional[datetime]

Last modified

formatdate-time
uuid: Optional[str]

Unique id

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

formatdate-time
user_id: Optional[str]

Id of user that created the knowledge base

formatint64
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

formatint64
model: Optional[APIAgentModel]

Description of a Model

agreement: Optional[APIAgreement]

Agreement Description

description: Optional[str]
name: Optional[str]
url: Optional[str]
uuid: Optional[str]
created_at: Optional[datetime]

Creation date / time

formatdate-time
inference_name: Optional[str]

Internally used name

inference_version: Optional[str]

Internally used version

is_foundational: Optional[bool]

True if it is a foundational model provided by do

metadata: Optional[object]

Additional meta data

name: Optional[str]

Name of the model

parent_uuid: Optional[str]

Unique id of the model, this model is based on

provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at: Optional[datetime]

Last modified

formatdate-time
upload_complete: Optional[bool]

Model has been fully uploaded

url: Optional[str]

Download url

usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]

Usecases of the model

Accepts one of the following:
"MODEL_USECASE_UNKNOWN"
"MODEL_USECASE_AGENT"
"MODEL_USECASE_FINETUNED"
"MODEL_USECASE_KNOWLEDGEBASE"
"MODEL_USECASE_GUARDRAIL"
"MODEL_USECASE_REASONING"
"MODEL_USECASE_SERVERLESS"
uuid: Optional[str]

Unique id

version: Optional[APIModelVersion]

Version Information about a Model

major: Optional[int]

Major version number

formatint64
minor: Optional[int]

Minor version number

formatint64
patch: Optional[int]

Patch version number

formatint64
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

formatfloat
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
Accepts one of the following:
"AGENT_TEMPLATE_TYPE_STANDARD"
"AGENT_TEMPLATE_TYPE_ONE_CLICK"
top_p: Optional[float]

The top_p setting for the agent template

formatfloat
updated_at: Optional[datetime]

The agent template's last updated date

formatdate-time
uuid: Optional[str]

Unique id

top_p: Optional[float]
updated_at: Optional[datetime]

Last modified

formatdate-time
url: Optional[str]

Access your agent under this url

user_id: Optional[str]

Id of user that created the agent

formatuint64
uuid: Optional[str]

Unique agent id

version_hash: Optional[str]

The latest version of the agent

workspace: Optional[APIWorkspace]

Links to other pages

Information about how to reach other pages

First page

Last page

Next page

Previous page

meta: Optional[APIMeta]

Meta information about the data set

page: Optional[int]

The current page

formatint64
pages: Optional[int]

Total number of pages

formatint64
total: Optional[int]

Total amount of items over all pages

formatint64
List agents by OpenAI key
  • http
  • typescript
  • python
from gradient import Gradient

client = Gradient()
response = client.agents.evaluation_metrics.openai.keys.list_agents(
    uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(response.agents)
{
  "agents": [
    {
      "anthropic_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "api_key_infos": [
        {
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "deleted_at": "2023-01-01T00:00:00Z",
          "name": "example name",
          "secret_key": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "api_keys": [
        {
          "api_key": "example string"
        }
      ],
      "chatbot": {
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "child_agents": [],
      "conversation_logs_enabled": true,
      "created_at": "2023-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "example string",
      "functions": [
        {
          "api_key": "example string",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "input_schema": {},
          "name": "example name",
          "output_schema": {},
          "updated_at": "2023-01-01T00:00:00Z",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "guardrails": [
        {
          "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2023-01-01T00:00:00Z",
          "default_response": "example string",
          "description": "example string",
          "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_attached": true,
          "is_default": true,
          "metadata": {},
          "name": "example name",
          "priority": 123,
          "type": "GUARDRAIL_TYPE_UNKNOWN",
          "updated_at": "2023-01-01T00:00:00Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "if_case": "example string",
      "instruction": "example string",
      "k": 123,
      "knowledge_bases": [
        {
          "added_to_agent_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "database_id": "123e4567-e89b-12d3-a456-426614174000",
          "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_public": true,
          "last_indexing_job": {
            "completed_datasources": 123,
            "created_at": "2023-01-01T00:00:00Z",
            "data_source_uuids": [
              "example string"
            ],
            "finished_at": "2023-01-01T00:00:00Z",
            "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "phase": "BATCH_JOB_PHASE_UNKNOWN",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "INDEX_JOB_STATUS_UNKNOWN",
            "tokens": 123,
            "total_datasources": 123,
            "total_items_failed": "12345",
            "total_items_indexed": "12345",
            "total_items_skipped": "12345",
            "updated_at": "2023-01-01T00:00:00Z",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "name": "example name",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "example string",
          "tags": [
            "example string"
          ],
          "updated_at": "2023-01-01T00:00:00Z",
          "user_id": "user_id",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "logging_config": {
        "galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "galileo_project_name": "example name",
        "insights_enabled": true,
        "insights_enabled_at": "2023-01-01T00:00:00Z",
        "log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
        "log_stream_name": "example name"
      },
      "max_tokens": 123,
      "model": {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      },
      "name": "example name",
      "openai_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "models": [
          {
            "agreement": {
              "description": "example string",
              "name": "example name",
              "url": "example string",
              "uuid": "123e4567-e89b-12d3-a456-426614174000"
            },
            "created_at": "2023-01-01T00:00:00Z",
            "inference_name": "example name",
            "inference_version": "example string",
            "is_foundational": true,
            "metadata": {},
            "name": "example name",
            "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "MODEL_PROVIDER_DIGITALOCEAN",
            "updated_at": "2023-01-01T00:00:00Z",
            "upload_complete": true,
            "url": "example string",
            "usecases": [
              "MODEL_USECASE_AGENT",
              "MODEL_USECASE_GUARDRAIL"
            ],
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "version": {
              "major": 123,
              "minor": 123,
              "patch": 123
            }
          }
        ],
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "parent_agents": [],
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "provide_citations": true,
      "region": "example string",
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "route_created_at": "2023-01-01T00:00:00Z",
      "route_created_by": "12345",
      "route_name": "example name",
      "route_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "template": {
        "created_at": "2023-01-01T00:00:00Z",
        "description": "example string",
        "guardrails": [
          {
            "priority": 123,
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "instruction": "example string",
        "k": 123,
        "knowledge_bases": [
          {
            "added_to_agent_at": "2023-01-01T00:00:00Z",
            "created_at": "2023-01-01T00:00:00Z",
            "database_id": "123e4567-e89b-12d3-a456-426614174000",
            "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "is_public": true,
            "last_indexing_job": {
              "completed_datasources": 123,
              "created_at": "2023-01-01T00:00:00Z",
              "data_source_uuids": [
                "example string"
              ],
              "finished_at": "2023-01-01T00:00:00Z",
              "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "phase": "BATCH_JOB_PHASE_UNKNOWN",
              "started_at": "2023-01-01T00:00:00Z",
              "status": "INDEX_JOB_STATUS_UNKNOWN",
              "tokens": 123,
              "total_datasources": 123,
              "total_items_failed": "12345",
              "total_items_indexed": "12345",
              "total_items_skipped": "12345",
              "updated_at": "2023-01-01T00:00:00Z",
              "uuid": "123e4567-e89b-12d3-a456-426614174000"
            },
            "name": "example name",
            "project_id": "123e4567-e89b-12d3-a456-426614174000",
            "region": "example string",
            "tags": [
              "example string"
            ],
            "updated_at": "2023-01-01T00:00:00Z",
            "user_id": "user_id",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
        "max_tokens": 123,
        "model": {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        },
        "name": "example name",
        "short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
        "summary": "example string",
        "tags": [
          "example string"
        ],
        "temperature": 123,
        "template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
        "top_p": 123,
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "top_p": 123,
      "updated_at": "2023-01-01T00:00:00Z",
      "url": "example string",
      "user_id": "12345",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "version_hash": "example string"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}
Returns Examples
{
  "agents": [
    {
      "anthropic_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "api_key_infos": [
        {
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "deleted_at": "2023-01-01T00:00:00Z",
          "name": "example name",
          "secret_key": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "api_keys": [
        {
          "api_key": "example string"
        }
      ],
      "chatbot": {
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "child_agents": [],
      "conversation_logs_enabled": true,
      "created_at": "2023-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "example string",
      "functions": [
        {
          "api_key": "example string",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "input_schema": {},
          "name": "example name",
          "output_schema": {},
          "updated_at": "2023-01-01T00:00:00Z",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "guardrails": [
        {
          "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2023-01-01T00:00:00Z",
          "default_response": "example string",
          "description": "example string",
          "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_attached": true,
          "is_default": true,
          "metadata": {},
          "name": "example name",
          "priority": 123,
          "type": "GUARDRAIL_TYPE_UNKNOWN",
          "updated_at": "2023-01-01T00:00:00Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "if_case": "example string",
      "instruction": "example string",
      "k": 123,
      "knowledge_bases": [
        {
          "added_to_agent_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "database_id": "123e4567-e89b-12d3-a456-426614174000",
          "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_public": true,
          "last_indexing_job": {
            "completed_datasources": 123,
            "created_at": "2023-01-01T00:00:00Z",
            "data_source_uuids": [
              "example string"
            ],
            "finished_at": "2023-01-01T00:00:00Z",
            "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "phase": "BATCH_JOB_PHASE_UNKNOWN",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "INDEX_JOB_STATUS_UNKNOWN",
            "tokens": 123,
            "total_datasources": 123,
            "total_items_failed": "12345",
            "total_items_indexed": "12345",
            "total_items_skipped": "12345",
            "updated_at": "2023-01-01T00:00:00Z",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "name": "example name",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "example string",
          "tags": [
            "example string"
          ],
          "updated_at": "2023-01-01T00:00:00Z",
          "user_id": "user_id",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "logging_config": {
        "galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "galileo_project_name": "example name",
        "insights_enabled": true,
        "insights_enabled_at": "2023-01-01T00:00:00Z",
        "log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
        "log_stream_name": "example name"
      },
      "max_tokens": 123,
      "model": {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      },
      "name": "example name",
      "openai_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "models": [
          {
            "agreement": {
              "description": "example string",
              "name": "example name",
              "url": "example string",
              "uuid": "123e4567-e89b-12d3-a456-426614174000"
            },
            "created_at": "2023-01-01T00:00:00Z",
            "inference_name": "example name",
            "inference_version": "example string",
            "is_foundational": true,
            "metadata": {},
            "name": "example name",
            "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "MODEL_PROVIDER_DIGITALOCEAN",
            "updated_at": "2023-01-01T00:00:00Z",
            "upload_complete": true,
            "url": "example string",
            "usecases": [
              "MODEL_USECASE_AGENT",
              "MODEL_USECASE_GUARDRAIL"
            ],
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "version": {
              "major": 123,
              "minor": 123,
              "patch": 123
            }
          }
        ],
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "parent_agents": [],
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "provide_citations": true,
      "region": "example string",
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "route_created_at": "2023-01-01T00:00:00Z",
      "route_created_by": "12345",
      "route_name": "example name",
      "route_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "template": {
        "created_at": "2023-01-01T00:00:00Z",
        "description": "example string",
        "guardrails": [
          {
            "priority": 123,
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "instruction": "example string",
        "k": 123,
        "knowledge_bases": [
          {
            "added_to_agent_at": "2023-01-01T00:00:00Z",
            "created_at": "2023-01-01T00:00:00Z",
            "database_id": "123e4567-e89b-12d3-a456-426614174000",
            "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "is_public": true,
            "last_indexing_job": {
              "completed_datasources": 123,
              "created_at": "2023-01-01T00:00:00Z",
              "data_source_uuids": [
                "example string"
              ],
              "finished_at": "2023-01-01T00:00:00Z",
              "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "phase": "BATCH_JOB_PHASE_UNKNOWN",
              "started_at": "2023-01-01T00:00:00Z",
              "status": "INDEX_JOB_STATUS_UNKNOWN",
              "tokens": 123,
              "total_datasources": 123,
              "total_items_failed": "12345",
              "total_items_indexed": "12345",
              "total_items_skipped": "12345",
              "updated_at": "2023-01-01T00:00:00Z",
              "uuid": "123e4567-e89b-12d3-a456-426614174000"
            },
            "name": "example name",
            "project_id": "123e4567-e89b-12d3-a456-426614174000",
            "region": "example string",
            "tags": [
              "example string"
            ],
            "updated_at": "2023-01-01T00:00:00Z",
            "user_id": "user_id",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
        "max_tokens": 123,
        "model": {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        },
        "name": "example name",
        "short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
        "summary": "example string",
        "tags": [
          "example string"
        ],
        "temperature": 123,
        "template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
        "top_p": 123,
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "top_p": 123,
      "updated_at": "2023-01-01T00:00:00Z",
      "url": "example string",
      "user_id": "12345",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "version_hash": "example string"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}