Move Agents to a Workspace

put/v2/gen-ai/workspaces/{workspace_uuid}/agents

To move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

Path ParametersExpand Collapse

workspace_uuid: string

Body ParametersExpand Collapse

agent_uuids: optional array of string

Agent uuids

workspace_uuid: optional string

Workspace uuid to move agents to

ReturnsExpand Collapse

workspace: optional APIWorkspace { agents, created_at, created_by, 7 more }

agents: optional array of APIAgent { anthropic_api_key, api_key_infos, api_keys, 40 more }

Agents

created_at: optional string

Creation date

formatdate-time

created_by: optional string

The id of user who created this workspace

formatuint64

created_by_email: optional string

The email of the user who created this workspace

deleted_at: optional string

Deleted date

formatdate-time

description: optional string

Description of the workspace

evaluation_test_cases: optional array of APIEvaluationTestCase { archived_at, created_at, created_by_user_email, 15 more }

Evaluations

archived_at: optional string

formatdate-time

created_at: optional string

formatdate-time

created_by_user_email: optional string

created_by_user_id: optional string

formatuint64

dataset: optional object { created_at, dataset_name, dataset_uuid, 3 more }

created_at: optional string

Time created at.

formatdate-time

dataset_name: optional string

Name of the dataset.

dataset_uuid: optional string

UUID of the dataset.

file_size: optional string

The size of the dataset uploaded file in bytes.

formatuint64

has_ground_truth: optional boolean

Does the dataset have a ground truth column?

row_count: optional number

Number of rows in the dataset.

formatint64

dataset_name: optional string

dataset_uuid: optional string

description: optional string

latest_version_number_of_runs: optional number

formatint32

metrics: optional array of APIEvaluationMetric { category, description, inverted, 8 more }

category: optional "METRIC_CATEGORY_UNSPECIFIED" or "METRIC_CATEGORY_CORRECTNESS" or "METRIC_CATEGORY_USER_OUTCOMES" or 3 more

Accepts one of the following:

"METRIC_CATEGORY_UNSPECIFIED"

"METRIC_CATEGORY_CORRECTNESS"

"METRIC_CATEGORY_USER_OUTCOMES"

"METRIC_CATEGORY_SAFETY_AND_SECURITY"

"METRIC_CATEGORY_CONTEXT_QUALITY"

"METRIC_CATEGORY_MODEL_FIT"

description: optional string

inverted: optional boolean

If true, the metric is inverted, meaning that a lower value is better.

is_metric_goal: optional boolean

metric_name: optional string

metric_rank: optional number

formatint64

metric_type: optional "METRIC_TYPE_UNSPECIFIED" or "METRIC_TYPE_GENERAL_QUALITY" or "METRIC_TYPE_RAG_AND_TOOL"

Accepts one of the following:

"METRIC_TYPE_UNSPECIFIED"

"METRIC_TYPE_GENERAL_QUALITY"

"METRIC_TYPE_RAG_AND_TOOL"

metric_uuid: optional string

metric_value_type: optional "METRIC_VALUE_TYPE_UNSPECIFIED" or "METRIC_VALUE_TYPE_NUMBER" or "METRIC_VALUE_TYPE_STRING" or "METRIC_VALUE_TYPE_PERCENTAGE"

Accepts one of the following:

"METRIC_VALUE_TYPE_UNSPECIFIED"

"METRIC_VALUE_TYPE_NUMBER"

"METRIC_VALUE_TYPE_STRING"

"METRIC_VALUE_TYPE_PERCENTAGE"

range_max: optional number

The maximum value for the metric.

formatfloat

range_min: optional number

The minimum value for the metric.

formatfloat

star_metric: optional APIStarMetric { metric_uuid, name, success_threshold, success_threshold_pct }

metric_uuid: optional string

success_threshold: optional number

The success threshold for the star metric. This is a value that the metric must reach to be considered successful.

formatfloat

success_threshold_pct: optional number

The success threshold for the star metric. This is a percentage value between 0 and 100.

formatint32

test_case_uuid: optional string

total_runs: optional number

formatint32

updated_at: optional string

formatdate-time

updated_by_user_email: optional string

updated_by_user_id: optional string

formatuint64

version: optional number

formatint64

Name of the workspace

updated_at: optional string

Update date

formatdate-time

uuid: optional string

Unique id

Move Agents to a Workspace

curl https://api.digitalocean.com/v2/gen-ai/workspaces/$WORKSPACE_UUID/agents \
    -X PUT \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

{
  "workspace": {
    "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": {
          "allowed_domains": [
            "example string"
          ],
          "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_jobs": [
                {
                  "completed_at": "2023-01-01T00:00:00Z",
                  "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "error_details": "example string",
                  "error_msg": "example string",
                  "failed_item_count": "12345",
                  "indexed_file_count": "12345",
                  "indexed_item_count": "12345",
                  "removed_item_count": "12345",
                  "skipped_item_count": "12345",
                  "started_at": "2023-01-01T00:00:00Z",
                  "status": "DATA_SOURCE_STATUS_UNKNOWN",
                  "total_bytes": "12345",
                  "total_bytes_indexed": "12345",
                  "total_file_count": "12345"
                }
              ],
              "data_source_uuids": [
                "example string"
              ],
              "finished_at": "2023-01-01T00:00:00Z",
              "is_report_available": true,
              "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_tokens": "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,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "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
          }
        },
        "model_provider_key": {
          "api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "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,
              "kb_default_chunk_size": 123,
              "kb_max_chunk_size": 123,
              "kb_min_chunk_size": 123,
              "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",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z"
        },
        "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,
              "kb_default_chunk_size": 123,
              "kb_max_chunk_size": 123,
              "kb_min_chunk_size": 123,
              "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_jobs": [
                  {
                    "completed_at": "2023-01-01T00:00:00Z",
                    "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "error_details": "example string",
                    "error_msg": "example string",
                    "failed_item_count": "12345",
                    "indexed_file_count": "12345",
                    "indexed_item_count": "12345",
                    "removed_item_count": "12345",
                    "skipped_item_count": "12345",
                    "started_at": "2023-01-01T00:00:00Z",
                    "status": "DATA_SOURCE_STATUS_UNKNOWN",
                    "total_bytes": "12345",
                    "total_bytes_indexed": "12345",
                    "total_file_count": "12345"
                  }
                ],
                "data_source_uuids": [
                  "example string"
                ],
                "finished_at": "2023-01-01T00:00:00Z",
                "is_report_available": true,
                "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_tokens": "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,
            "kb_default_chunk_size": 123,
            "kb_max_chunk_size": 123,
            "kb_min_chunk_size": 123,
            "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",
        "vpc_egress_ips": [
          "example string"
        ],
        "vpc_uuid": "\"12345678-1234-1234-1234-123456789012\""
      }
    ],
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "created_by_email": "example@example.com",
    "deleted_at": "2023-01-01T00:00:00Z",
    "description": "example string",
    "evaluation_test_cases": [
      {
        "archived_at": "2023-01-01T00:00:00Z",
        "created_at": "2023-01-01T00:00:00Z",
        "created_by_user_email": "example@example.com",
        "created_by_user_id": "12345",
        "dataset": {
          "created_at": "2023-01-01T00:00:00Z",
          "dataset_name": "example name",
          "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "file_size": "12345",
          "has_ground_truth": true,
          "row_count": 123
        },
        "dataset_name": "example name",
        "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "example string",
        "latest_version_number_of_runs": 123,
        "metrics": [
          {
            "category": "METRIC_CATEGORY_UNSPECIFIED",
            "description": "example string",
            "inverted": true,
            "is_metric_goal": true,
            "metric_name": "example name",
            "metric_rank": 123,
            "metric_type": "METRIC_TYPE_UNSPECIFIED",
            "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
            "range_max": 123,
            "range_min": 123
          }
        ],
        "name": "example name",
        "star_metric": {
          "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "example name",
          "success_threshold": 123,
          "success_threshold_pct": 123
        },
        "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "total_runs": 123,
        "updated_at": "2023-01-01T00:00:00Z",
        "updated_by_user_email": "example@example.com",
        "updated_by_user_id": "12345",
        "version": 123
      }
    ],
    "name": "example name",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Returns Examples

{
  "workspace": {
    "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": {
          "allowed_domains": [
            "example string"
          ],
          "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_jobs": [
                {
                  "completed_at": "2023-01-01T00:00:00Z",
                  "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "error_details": "example string",
                  "error_msg": "example string",
                  "failed_item_count": "12345",
                  "indexed_file_count": "12345",
                  "indexed_item_count": "12345",
                  "removed_item_count": "12345",
                  "skipped_item_count": "12345",
                  "started_at": "2023-01-01T00:00:00Z",
                  "status": "DATA_SOURCE_STATUS_UNKNOWN",
                  "total_bytes": "12345",
                  "total_bytes_indexed": "12345",
                  "total_file_count": "12345"
                }
              ],
              "data_source_uuids": [
                "example string"
              ],
              "finished_at": "2023-01-01T00:00:00Z",
              "is_report_available": true,
              "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_tokens": "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,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "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
          }
        },
        "model_provider_key": {
          "api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "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,
              "kb_default_chunk_size": 123,
              "kb_max_chunk_size": 123,
              "kb_min_chunk_size": 123,
              "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",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z"
        },
        "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,
              "kb_default_chunk_size": 123,
              "kb_max_chunk_size": 123,
              "kb_min_chunk_size": 123,
              "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_jobs": [
                  {
                    "completed_at": "2023-01-01T00:00:00Z",
                    "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "error_details": "example string",
                    "error_msg": "example string",
                    "failed_item_count": "12345",
                    "indexed_file_count": "12345",
                    "indexed_item_count": "12345",
                    "removed_item_count": "12345",
                    "skipped_item_count": "12345",
                    "started_at": "2023-01-01T00:00:00Z",
                    "status": "DATA_SOURCE_STATUS_UNKNOWN",
                    "total_bytes": "12345",
                    "total_bytes_indexed": "12345",
                    "total_file_count": "12345"
                  }
                ],
                "data_source_uuids": [
                  "example string"
                ],
                "finished_at": "2023-01-01T00:00:00Z",
                "is_report_available": true,
                "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_tokens": "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,
            "kb_default_chunk_size": 123,
            "kb_max_chunk_size": 123,
            "kb_min_chunk_size": 123,
            "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",
        "vpc_egress_ips": [
          "example string"
        ],
        "vpc_uuid": "\"12345678-1234-1234-1234-123456789012\""
      }
    ],
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "created_by_email": "example@example.com",
    "deleted_at": "2023-01-01T00:00:00Z",
    "description": "example string",
    "evaluation_test_cases": [
      {
        "archived_at": "2023-01-01T00:00:00Z",
        "created_at": "2023-01-01T00:00:00Z",
        "created_by_user_email": "example@example.com",
        "created_by_user_id": "12345",
        "dataset": {
          "created_at": "2023-01-01T00:00:00Z",
          "dataset_name": "example name",
          "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "file_size": "12345",
          "has_ground_truth": true,
          "row_count": 123
        },
        "dataset_name": "example name",
        "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "example string",
        "latest_version_number_of_runs": 123,
        "metrics": [
          {
            "category": "METRIC_CATEGORY_UNSPECIFIED",
            "description": "example string",
            "inverted": true,
            "is_metric_goal": true,
            "metric_name": "example name",
            "metric_rank": 123,
            "metric_type": "METRIC_TYPE_UNSPECIFIED",
            "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
            "range_max": 123,
            "range_min": 123
          }
        ],
        "name": "example name",
        "star_metric": {
          "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "example name",
          "success_threshold": 123,
          "success_threshold_pct": 123
        },
        "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "total_runs": 123,
        "updated_at": "2023-01-01T00:00:00Z",
        "updated_by_user_email": "example@example.com",
        "updated_by_user_id": "12345",
        "version": 123
      }
    ],
    "name": "example name",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}