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

Move

API Reference
Agents
Evaluation Metrics
Workspaces
Agents
Move Agents to a Workspace
client.agents.evaluationMetrics.workspaces.agents.move(stringworkspaceUuid, AgentMoveParams { agent_uuids, workspace_uuid } body?, RequestOptionsoptions?): AgentMoveResponse { 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.

ParametersExpand Collapse
workspaceUuid: string
body: AgentMoveParams { agent_uuids, workspace_uuid }
agent_uuids?: Array<string>

Agent uuids

workspace_uuid?: string

Workspace uuid to move agents to

ReturnsExpand Collapse
AgentMoveResponse { workspace }
workspace?: APIWorkspace { agents, created_at, created_by, 7 more }
agents?: Array<APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more } >

Agents

APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more }

An Agent

anthropic_api_key?: APIAnthropicAPIKeyInfo { created_at, created_by, deleted_at, 3 more }

Anthropic API Key Info

created_at?: string

Key creation date

formatdate-time
created_by?: string

Created by user id from DO

formatuint64
deleted_at?: string

Key deleted date

formatdate-time
name?: string

Name

updated_at?: string

Key last updated date

formatdate-time
uuid?: string

Uuid

api_key_infos?: Array<APIAgentAPIKeyInfo { created_at, created_by, deleted_at, 3 more } >

Api key infos

created_at?: string

Creation date

formatdate-time
created_by?: string

Created by

formatuint64
deleted_at?: string

Deleted date

formatdate-time
name?: string

Name

secret_key?: string
uuid?: string

Uuid

api_keys?: Array<APIKey>

Api keys

api_key?: string

Api key

chatbot?: Chatbot { button_background_color, logo, name, 3 more }

A Chatbot

button_background_color?: string
name?: string

Name of chatbot

primary_color?: string
secondary_color?: string
starting_message?: string
chatbot_identifiers?: Array<ChatbotIdentifier>

Chatbot identifiers

agent_chatbot_identifier?: string

Agent chatbot identifier

child_agents?: Array<APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more } >

Child agents

APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more }
conversation_logs_enabled?: boolean

Whether conversation logs are enabled for the agent

created_at?: string

Creation date / time

formatdate-time
deployment?: Deployment { created_at, name, status, 4 more }

Description of deployment

created_at?: string

Creation date / time

formatdate-time
name?: string

Name

status?: "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?: string

Last modified

formatdate-time
url?: string

Access your deployed agent here

uuid?: string

Unique id

  • 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?: string

Description of agent

functions?: Array<Function>
api_key?: string

Api key

created_at?: string

Creation date / time

formatdate-time
created_by?: string

Created by user id from DO

formatuint64
description?: string

Agent description

faas_name?: string
faas_namespace?: string
input_schema?: unknown
name?: string

Name

output_schema?: unknown
updated_at?: string

Last modified

formatdate-time
url?: string

Download your agent here

uuid?: string

Unique id

guardrails?: Array<Guardrail>

The guardrails the agent is attached to

agent_uuid?: string
created_at?: string
default_response?: string
description?: string
guardrail_uuid?: string
is_attached?: boolean
is_default?: boolean
metadata?: unknown
name?: string
priority?: number
type?: "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?: string
uuid?: string
if_case?: string
instruction?: string

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

k?: number
knowledge_bases?: Array<APIKnowledgeBase { added_to_agent_at, created_at, database_id, 10 more } >

Knowledge bases

added_to_agent_at?: string

Time when the knowledge base was added to the agent

formatdate-time
created_at?: string

Creation date / time

formatdate-time
database_id?: string
embedding_model_uuid?: string
is_public?: boolean

Whether the knowledge base is public or not

last_indexing_job?: APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_uuids?: Array<string>
finished_at?: string
knowledge_base_uuid?: string

Knowledge base id

phase?: "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?: string
status?: "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?: number

Number of tokens

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_items_failed?: string

Total Items Failed

formatuint64
total_items_indexed?: string

Total Items Indexed

formatuint64
total_items_skipped?: string

Total Items Skipped

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

name?: string

Name of knowledge base

project_id?: string
region?: string

Region code

tags?: Array<string>

Tags to organize related resources

updated_at?: string

Last modified

formatdate-time
user_id?: string

Id of user that created the knowledge base

formatint64
uuid?: string

Unique id for knowledge base

logging_config?: LoggingConfig { galileo_project_id, galileo_project_name, insights_enabled, 3 more }
galileo_project_id?: string

Galileo project identifier

galileo_project_name?: string

Name of the Galileo project

insights_enabled?: boolean

Whether insights are enabled

insights_enabled_at?: string

Timestamp when insights were enabled

formatdate-time
log_stream_id?: string

Identifier for the log stream

log_stream_name?: string

Name of the log stream

max_tokens?: number
model?: APIAgentModel { agreement, created_at, inference_name, 12 more }

Description of a Model

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string
name?: string
url?: string
uuid?: string
created_at?: string

Creation date / time

formatdate-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?: unknown

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"
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at?: string

Last modified

formatdate-time
upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

usecases?: Array<"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?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
name?: string

Agent name

openai_api_key?: APIOpenAIAPIKeyInfo { created_at, created_by, deleted_at, 4 more }

OpenAI API Key Info

created_at?: string

Key creation date

formatdate-time
created_by?: string

Created by user id from DO

formatuint64
deleted_at?: string

Key deleted date

formatdate-time
models?: Array<APIAgentModel { agreement, created_at, inference_name, 12 more } >

Models supported by the openAI api key

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string
name?: string
url?: string
uuid?: string
created_at?: string

Creation date / time

formatdate-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?: unknown

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"
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at?: string

Last modified

formatdate-time
upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

usecases?: Array<"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?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
name?: string

Name

updated_at?: string

Key last updated date

formatdate-time
uuid?: string

Uuid

parent_agents?: Array<APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more } >

Parent agents

APIAgent { anthropic_api_key, api_key_infos, api_keys, 37 more }
project_id?: string
provide_citations?: boolean

Whether the agent should provide in-response citations

region?: string

Region code

retrieval_method?: APIRetrievalMethod
  • RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
  • RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
  • RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
  • RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
  • RETRIEVAL_METHOD_NONE: The retrieval method is none
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?: string

Creation of route date / time

formatdate-time
route_created_by?: string
route_name?: string

Route name

route_uuid?: string
tags?: Array<string>

Agent tag to organize related resources

temperature?: number
template?: Template { created_at, description, guardrails, 15 more }

Represents an AgentTemplate entity

created_at?: string

The agent template's creation date

formatdate-time
description?: string

Deprecated - Use summary instead

guardrails?: Array<Guardrail>

List of guardrails associated with the agent template

priority?: number

Priority of the guardrail

formatint32
uuid?: string

Uuid of the guardrail

instruction?: string

Instructions for the agent template

k?: number

The 'k' value for the agent template

formatint64
knowledge_bases?: Array<APIKnowledgeBase { added_to_agent_at, created_at, database_id, 10 more } >

List of knowledge bases associated with the agent template

added_to_agent_at?: string

Time when the knowledge base was added to the agent

formatdate-time
created_at?: string

Creation date / time

formatdate-time
database_id?: string
embedding_model_uuid?: string
is_public?: boolean

Whether the knowledge base is public or not

last_indexing_job?: APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_uuids?: Array<string>
finished_at?: string
knowledge_base_uuid?: string

Knowledge base id

phase?: "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?: string
status?: "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?: number

Number of tokens

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_items_failed?: string

Total Items Failed

formatuint64
total_items_indexed?: string

Total Items Indexed

formatuint64
total_items_skipped?: string

Total Items Skipped

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

name?: string

Name of knowledge base

project_id?: string
region?: string

Region code

tags?: Array<string>

Tags to organize related resources

updated_at?: string

Last modified

formatdate-time
user_id?: string

Id of user that created the knowledge base

formatint64
uuid?: string

Unique id for knowledge base

long_description?: string

The long description of the agent template

max_tokens?: number

The max_tokens setting for the agent template

formatint64
model?: APIAgentModel { agreement, created_at, inference_name, 12 more }

Description of a Model

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string
name?: string
url?: string
uuid?: string
created_at?: string

Creation date / time

formatdate-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?: unknown

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"
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at?: string

Last modified

formatdate-time
upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

usecases?: Array<"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?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
name?: string

Name of the agent template

short_description?: string

The short description of the agent template

summary?: string

The summary of the agent template

tags?: Array<string>

List of tags associated with the agent template

temperature?: number

The temperature setting for the agent template

formatfloat
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
Accepts one of the following:
"AGENT_TEMPLATE_TYPE_STANDARD"
"AGENT_TEMPLATE_TYPE_ONE_CLICK"
top_p?: number

The top_p setting for the agent template

formatfloat
updated_at?: string

The agent template's last updated date

formatdate-time
uuid?: string

Unique id

top_p?: number
updated_at?: string

Last modified

formatdate-time
url?: string

Access your agent under this url

user_id?: string

Id of user that created the agent

formatuint64
uuid?: string

Unique agent id

version_hash?: string

The latest version of the agent

workspace?: APIWorkspace { agents, created_at, created_by, 7 more }
created_at?: string

Creation date

formatdate-time
created_by?: string

The id of user who created this workspace

formatuint64
created_by_email?: string

The email of the user who created this workspace

deleted_at?: string

Deleted date

formatdate-time
description?: string

Description of the workspace

evaluation_test_cases?: Array<APIEvaluationTestCase { archived_at, created_at, created_by_user_email, 15 more } >

Evaluations

archived_at?: string
created_at?: string
created_by_user_email?: string
created_by_user_id?: string
dataset?: Dataset { created_at, dataset_name, dataset_uuid, 3 more }
created_at?: string

Time created at.

formatdate-time
dataset_name?: string

Name of the dataset.

dataset_uuid?: string

UUID of the dataset.

file_size?: string

The size of the dataset uploaded file in bytes.

formatuint64
has_ground_truth?: boolean

Does the dataset have a ground truth column?

row_count?: number

Number of rows in the dataset.

formatint64
dataset_name?: string
dataset_uuid?: string
description?: string
latest_version_number_of_runs?: number
metrics?: Array<APIEvaluationMetric { description, inverted, metric_name, 5 more } >
description?: string
inverted?: boolean

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

metric_name?: string
metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"
Accepts one of the following:
"METRIC_TYPE_UNSPECIFIED"
"METRIC_TYPE_GENERAL_QUALITY"
"METRIC_TYPE_RAG_AND_TOOL"
metric_uuid?: string
metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "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?: number

The maximum value for the metric.

formatfloat
range_min?: number

The minimum value for the metric.

formatfloat
name?: string
star_metric?: APIStarMetric { metric_uuid, name, success_threshold, success_threshold_pct }
metric_uuid?: string
name?: string
success_threshold?: 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?: number

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

formatint32
test_case_uuid?: string
total_runs?: number
updated_at?: string
updated_by_user_email?: string
updated_by_user_id?: string
version?: number
name?: string

Name of the workspace

updated_at?: string

Update date

formatdate-time
uuid?: string

Unique id

Move Agents to a Workspace
  • http
  • typescript
  • python
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.agents.evaluationMetrics.workspaces.agents.move(
  '"123e4567-e89b-12d3-a456-426614174000"',
);

console.log(response.workspace);
{
  "workspace": {
    "agents": [],
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "created_by_email": "[email protected]",
    "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": "[email protected]",
        "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": [
          {
            "description": "example string",
            "inverted": true,
            "metric_name": "example name",
            "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": "[email protected]",
        "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": [],
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "created_by_email": "[email protected]",
    "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": "[email protected]",
        "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": [
          {
            "description": "example string",
            "inverted": true,
            "metric_name": "example name",
            "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": "[email protected]",
        "updated_by_user_id": "12345",
        "version": 123
      }
    ],
    "name": "example name",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}