Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
API Reference
Agents
Knowledge Bases

Attach Knowledge Bases to an Agent

client.agents.knowledgeBases.attach(stringagentUuid, RequestOptionsoptions?): APILinkKnowledgeBaseOutput { agent }
post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases

To attach knowledge bases to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases

ParametersExpand Collapse
agentUuid: string
ReturnsExpand Collapse
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

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

Accepts one of the following:
Accepts one of the following:
"VISIBILITY_UNKNOWN"
"VISIBILITY_DISABLED"
"VISIBILITY_PLAYGROUND"
"VISIBILITY_PUBLIC"
"VISIBILITY_PRIVATE"
Accepts one of the following:
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
description?: string
name?: string
url?: string
uuid?: string
Accepts one of the following:
Accepts one of the following:
major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
Accepts one of the following:
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, 15 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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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

Accepts one of the following:
"RETRIEVAL_METHOD_UNKNOWN"
"RETRIEVAL_METHOD_REWRITE"
"RETRIEVAL_METHOD_STEP_BACK"
"RETRIEVAL_METHOD_SUB_QUERIES"
"RETRIEVAL_METHOD_NONE"
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
Accepts one of the following:
Accepts one of the following:
Accepts one of the following:
"VISIBILITY_UNKNOWN"
"VISIBILITY_DISABLED"
"VISIBILITY_PLAYGROUND"
"VISIBILITY_PUBLIC"
"VISIBILITY_PRIVATE"
Accepts one of the following:
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
description?: string
name?: string
url?: string
uuid?: string
Accepts one of the following:
Accepts one of the following:
major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
Accepts one of the following:
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, 15 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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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

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

Accepts one of the following:
Accepts one of the following:
"VISIBILITY_UNKNOWN"
"VISIBILITY_DISABLED"
"VISIBILITY_PLAYGROUND"
"VISIBILITY_PUBLIC"
"VISIBILITY_PRIVATE"
Accepts one of the following:
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
description?: string
name?: string
url?: string
uuid?: string
Accepts one of the following:
Accepts one of the following:
major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
Accepts one of the following:
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, 15 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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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

Accepts one of the following:
"RETRIEVAL_METHOD_UNKNOWN"
"RETRIEVAL_METHOD_REWRITE"
"RETRIEVAL_METHOD_STEP_BACK"
"RETRIEVAL_METHOD_SUB_QUERIES"
"RETRIEVAL_METHOD_NONE"
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
Accepts one of the following:
Accepts one of the following:
"RETRIEVAL_METHOD_UNKNOWN"
"RETRIEVAL_METHOD_REWRITE"
"RETRIEVAL_METHOD_STEP_BACK"
"RETRIEVAL_METHOD_SUB_QUERIES"
"RETRIEVAL_METHOD_NONE"
completed_datasources?: number

Number of datasources indexed completed

formatint64
created_at?: string

Creation date / time

formatdate-time
data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64
indexed_file_count?: string

Total count of files that have been indexed

formatuint64
indexed_item_count?: string

Total count of files that have been indexed

formatuint64
removed_item_count?: string

Total count of files that have been removed

formatuint64
skipped_item_count?: string

Total count of files that have been skipped

formatuint64
started_at?: string

Timestamp when data source started indexing

formatdate-time
status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes?: string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count?: string

Total file count in the data source

formatuint64
data_source_uuids?: Array<string>
finished_at?: string
formatdate-time
is_report_available?: boolean

Boolean value to determine if the indexing job details are available

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
formatdate-time
status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 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"
"INDEX_JOB_STATUS_CANCELLED"
tokens?: number

Number of tokens [This field is deprecated]

formatint64
total_datasources?: number

Number of datasources being indexed

formatint64
total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at?: string

Last modified

formatdate-time
uuid?: string

Unique id

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

kb_default_chunk_size?: number

Default chunking size limit to show in UI

formatint64
kb_max_chunk_size?: number

Maximum chunk size limit of model

formatint64
kb_min_chunk_size?: number

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64
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
Accepts one of the following:
Attach Knowledge Bases to an Agent
import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const apiLinkKnowledgeBaseOutput = await client.agents.knowledgeBases.attach(
  '"123e4567-e89b-12d3-a456-426614174000"',
);

console.log(apiLinkKnowledgeBaseOutput.agent);
{
  "agent": {
    "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\"",
    "workspace": {
      "agents": [],
      "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
{
  "agent": {
    "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\"",
    "workspace": {
      "agents": [],
      "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"
    }
  }
}