Agents

API Reference

Agents

Create an Agent

client.agents.create(AgentCreateParams { anthropic_key_uuid, description, instruction, 7 more } body?, RequestOptionsoptions?): AgentCreateResponse { agent }

post/v2/gen-ai/agents

Delete an Agent

client.agents.delete(stringuuid, RequestOptionsoptions?): AgentDeleteResponse { agent }

delete/v2/gen-ai/agents/{uuid}

List Agents

client.agents.list(AgentListParams { only_deployed, page, per_page } query?, RequestOptionsoptions?): AgentListResponse { agents, links, meta }

get/v2/gen-ai/agents

Retrieve an Existing Agent

client.agents.retrieve(stringuuid, RequestOptionsoptions?): AgentRetrieveResponse { agent }

get/v2/gen-ai/agents/{uuid}

Get Agent Usage

client.agents.retrieveUsage(stringuuid, AgentRetrieveUsageParams { start, stop } query?, RequestOptionsoptions?): AgentRetrieveUsageResponse { log_insights_usage, usage }

get/v2/gen-ai/agents/{uuid}/usage

Update an Agent

client.agents.update(stringpathUuid, AgentUpdateParams { agent_log_insights_enabled, anthropic_key_uuid, conversation_logs_enabled, 14 more } body?, RequestOptionsoptions?): AgentUpdateResponse { agent }

put/v2/gen-ai/agents/{uuid}

Update Agent Status

client.agents.updateStatus(stringpathUuid, AgentUpdateStatusParams { body_uuid, visibility } body?, RequestOptionsoptions?): AgentUpdateStatusResponse { agent }

put/v2/gen-ai/agents/{uuid}/deployment_visibility

ModelsExpand Collapse

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

logo?: 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 }

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

logo?: 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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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

logo?: 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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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 }

APIAgentAPIKeyInfo { created_at, created_by, deleted_at, 3 more }

Agent API Key Info

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

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

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

APIDeploymentVisibility = "VISIBILITY_UNKNOWN" | "VISIBILITY_DISABLED" | "VISIBILITY_PLAYGROUND" | 2 more

• 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"

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

APIRetrievalMethod = "RETRIEVAL_METHOD_UNKNOWN" | "RETRIEVAL_METHOD_REWRITE" | "RETRIEVAL_METHOD_STEP_BACK" | 2 more

• 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"

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

logo?: 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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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

AgentsAPI Keys

Create an Agent API Key

client.agents.apiKeys.create(stringagentUuid, APIKeyCreateParams { agent_uuid, name } body?, RequestOptionsoptions?): APIKeyCreateResponse { api_key_info }

post/v2/gen-ai/agents/{agent_uuid}/api_keys

Delete API Key for an Agent

client.agents.apiKeys.delete(stringapiKeyUuid, APIKeyDeleteParams { agent_uuid } params, RequestOptionsoptions?): APIKeyDeleteResponse { api_key_info }

delete/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

List Agent API Keys

client.agents.apiKeys.list(stringagentUuid, APIKeyListParams { page, per_page } query?, RequestOptionsoptions?): APIKeyListResponse { api_key_infos, links, meta }

get/v2/gen-ai/agents/{agent_uuid}/api_keys

Regenerate API Key for an Agent

client.agents.apiKeys.regenerate(stringapiKeyUuid, APIKeyRegenerateParams { agent_uuid } params, RequestOptionsoptions?): APIKeyRegenerateResponse { api_key_info }

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate

Update API Key for an Agent

client.agents.apiKeys.update(stringapiKeyUuid, APIKeyUpdateParams { body_agent_uuid, api_key_uuid, name } params, RequestOptionsoptions?): APIKeyUpdateResponse { api_key_info }

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

AgentsChat

AgentsChatCompletions

Creates a model response for the given chat conversation.

client.agents.chat.completions.create(CompletionCreateParamsbody, RequestOptionsoptions?): CompletionCreateResponse { id, choices, created, 3 more } | Stream<ChatCompletionChunk { id, choices, created, 3 more } >

post/chat/completions?agent=true

AgentsEvaluation Datasets

Create Evaluation Dataset

client.agents.evaluationDatasets.create(EvaluationDatasetCreateParams { file_upload_dataset, name } body?, RequestOptionsoptions?): EvaluationDatasetCreateResponse { evaluation_dataset_uuid }

post/v2/gen-ai/evaluation_datasets

Create Presigned URLs for Evaluation Dataset File Upload

client.agents.evaluationDatasets.createFileUploadPresignedURLs(EvaluationDatasetCreateFileUploadPresignedURLsParams { files } body?, RequestOptionsoptions?): EvaluationDatasetCreateFileUploadPresignedURLsResponse { request_id, uploads }

post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls

AgentsEvaluation Metrics

List Evaluation Metrics

client.agents.evaluationMetrics.list(RequestOptionsoptions?): EvaluationMetricListResponse { metrics }

get/v2/gen-ai/evaluation_metrics

List Datacenter Regions

client.agents.evaluationMetrics.listRegions(EvaluationMetricListRegionsParams { serves_batch, serves_inference } query?, RequestOptionsoptions?): EvaluationMetricListRegionsResponse { regions }

get/v2/gen-ai/regions

AgentsEvaluation MetricsAnthropic

AgentsEvaluation MetricsAnthropicKeys

Create Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.create(KeyCreateParams { api_key, name } body?, RequestOptionsoptions?): KeyCreateResponse { api_key_info }

post/v2/gen-ai/anthropic/keys

Delete Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse { api_key_info }

delete/v2/gen-ai/anthropic/keys/{api_key_uuid}

List Anthropic API Keys

client.agents.evaluationMetrics.anthropic.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { api_key_infos, links, meta }

get/v2/gen-ai/anthropic/keys

List agents by Anthropic key

client.agents.evaluationMetrics.anthropic.keys.listAgents(stringuuid, KeyListAgentsParams { page, per_page } query?, RequestOptionsoptions?): KeyListAgentsResponse { agents, links, meta }

get/v2/gen-ai/anthropic/keys/{uuid}/agents

Get Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse { api_key_info }

get/v2/gen-ai/anthropic/keys/{api_key_uuid}

Update Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.update(stringapiKeyUuid, KeyUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): KeyUpdateResponse { api_key_info }

put/v2/gen-ai/anthropic/keys/{api_key_uuid}

AgentsEvaluation MetricsModels

List Available Models

client.agents.evaluationMetrics.models.list(ModelListParams { page, per_page, public_only, usecases } query?, RequestOptionsoptions?): ModelListResponse { links, meta, models }

get/v2/gen-ai/models

AgentsEvaluation MetricsOauth2

Get Oauth2 URL

client.agents.evaluationMetrics.oauth2.generateURL(Oauth2GenerateURLParams { redirect_url, type } query?, RequestOptionsoptions?): Oauth2GenerateURLResponse { url }

get/v2/gen-ai/oauth2/url

AgentsEvaluation MetricsOauth2Dropbox

Get Oauth2 Dropbox Tokens

client.agents.evaluationMetrics.oauth2.dropbox.createTokens(DropboxCreateTokensParams { code, redirect_url } body?, RequestOptionsoptions?): DropboxCreateTokensResponse { token, refresh_token }

post/v2/gen-ai/oauth2/dropbox/tokens

AgentsEvaluation MetricsOpenAI

AgentsEvaluation MetricsOpenAIKeys

Create OpenAI API Key

client.agents.evaluationMetrics.openai.keys.create(KeyCreateParams { api_key, name } body?, RequestOptionsoptions?): KeyCreateResponse { api_key_info }

post/v2/gen-ai/openai/keys

Delete OpenAI API Key

client.agents.evaluationMetrics.openai.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse { api_key_info }

delete/v2/gen-ai/openai/keys/{api_key_uuid}

List OpenAI API Keys

client.agents.evaluationMetrics.openai.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { api_key_infos, links, meta }

get/v2/gen-ai/openai/keys

List agents by OpenAI key

client.agents.evaluationMetrics.openai.keys.listAgents(stringuuid, KeyListAgentsParams { page, per_page } query?, RequestOptionsoptions?): KeyListAgentsResponse { agents, links, meta }

get/v2/gen-ai/openai/keys/{uuid}/agents

Get OpenAI API Key

client.agents.evaluationMetrics.openai.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse { api_key_info }

get/v2/gen-ai/openai/keys/{api_key_uuid}

Update OpenAI API Key

client.agents.evaluationMetrics.openai.keys.update(stringapiKeyUuid, KeyUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): KeyUpdateResponse { api_key_info }

put/v2/gen-ai/openai/keys/{api_key_uuid}

AgentsEvaluation MetricsWorkspaces

Create a Workspace

client.agents.evaluationMetrics.workspaces.create(WorkspaceCreateParams { agent_uuids, description, name } body?, RequestOptionsoptions?): WorkspaceCreateResponse { workspace }

post/v2/gen-ai/workspaces

Delete a Workspace

client.agents.evaluationMetrics.workspaces.delete(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceDeleteResponse { workspace_uuid }

delete/v2/gen-ai/workspaces/{workspace_uuid}

List Workspaces

client.agents.evaluationMetrics.workspaces.list(RequestOptionsoptions?): WorkspaceListResponse { workspaces }

get/v2/gen-ai/workspaces

List Evaluation Test Cases by Workspace

client.agents.evaluationMetrics.workspaces.listEvaluationTestCases(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceListEvaluationTestCasesResponse { evaluation_test_cases }

get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases

Retrieve an Existing Workspace

client.agents.evaluationMetrics.workspaces.retrieve(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceRetrieveResponse { workspace }

get/v2/gen-ai/workspaces/{workspace_uuid}

Update a Workspace

client.agents.evaluationMetrics.workspaces.update(stringworkspaceUuid, WorkspaceUpdateParams { description, name, workspace_uuid } body?, RequestOptionsoptions?): WorkspaceUpdateResponse { workspace }

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

AgentsEvaluation MetricsWorkspacesAgents

List agents by Workspace

client.agents.evaluationMetrics.workspaces.agents.list(stringworkspaceUuid, AgentListParams { only_deployed, page, per_page } query?, RequestOptionsoptions?): AgentListResponse { agents, links, meta }

get/v2/gen-ai/workspaces/{workspace_uuid}/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

AgentsEvaluation Runs

Run an Evaluation Test Case

client.agents.evaluationRuns.create(EvaluationRunCreateParams { agent_uuids, run_name, test_case_uuid } body?, RequestOptionsoptions?): EvaluationRunCreateResponse { evaluation_run_uuids }

post/v2/gen-ai/evaluation_runs

Retrieve Results of an Evaluation Run

client.agents.evaluationRuns.listResults(stringevaluationRunUuid, EvaluationRunListResultsParams { page, per_page } query?, RequestOptionsoptions?): EvaluationRunListResultsResponse { evaluation_run, links, meta, prompts }

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results

Retrieve Information About an Existing Evaluation Run

client.agents.evaluationRuns.retrieve(stringevaluationRunUuid, RequestOptionsoptions?): EvaluationRunRetrieveResponse { evaluation_run }

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}

Retrieve Results of an Evaluation Run Prompt

client.agents.evaluationRuns.retrieveResults(numberpromptID, EvaluationRunRetrieveResultsParams { evaluation_run_uuid } params, RequestOptionsoptions?): EvaluationRunRetrieveResultsResponse { prompt }

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}

ModelsExpand Collapse

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

APIEvaluationMetricResult { error_description, metric_name, metric_value_type, 3 more }

error_description?: string

Error description if the metric could not be calculated.

metric_name?: string

Metric name

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"

number_value?: number

The value of the metric as a number.

formatdouble

reasoning?: string

Reasoning of the metric result.

string_value?: string

The value of the metric as a string.

APIEvaluationPrompt { ground_truth, input, input_tokens, 5 more }

ground_truth?: string

The ground truth for the prompt.

input?: string

input_tokens?: string

The number of input tokens used in the prompt.

formatuint64

output?: string

output_tokens?: string

The number of output tokens used in the prompt.

formatuint64

prompt_chunks?: Array<PromptChunk>

The list of prompt chunks.

chunk_usage_pct?: number

The usage percentage of the chunk.

formatdouble

chunk_used?: boolean

Indicates if the chunk was used in the prompt.

index_uuid?: string

The index uuid (Knowledge Base) of the chunk.

source_name?: string

The source name for the chunk, e.g., the file name or document title.

text?: string

Text content of the chunk.

prompt_id?: number

Prompt ID

formatint64

prompt_level_metric_results?: Array<APIEvaluationMetricResult { error_description, metric_name, metric_value_type, 3 more } >

The metric results for the prompt.

error_description?: string

Error description if the metric could not be calculated.

metric_name?: string

Metric name

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"

number_value?: number

The value of the metric as a number.

formatdouble

reasoning?: string

Reasoning of the metric result.

string_value?: string

The value of the metric as a string.

APIEvaluationRun { agent_deleted, agent_name, agent_uuid, 19 more }

agent_deleted?: boolean

Whether agent is deleted

agent_name?: string

Agent name

agent_uuid?: string

Agent UUID.

agent_version_hash?: string

Version hash

agent_workspace_uuid?: string

Agent workspace uuid

created_by_user_email?: string

created_by_user_id?: string

error_description?: string

The error description

evaluation_run_uuid?: string

Evaluation run UUID.

evaluation_test_case_workspace_uuid?: string

Evaluation test case workspace uuid

finished_at?: string

Run end time.

formatdate-time

pass_status?: boolean

The pass status of the evaluation run based on the star metric.

queued_at?: string

Run queued time.

formatdate-time

run_level_metric_results?: Array<APIEvaluationMetricResult { error_description, metric_name, metric_value_type, 3 more } >

error_description?: string

Error description if the metric could not be calculated.

metric_name?: string

Metric name

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"

number_value?: number

The value of the metric as a number.

formatdouble

reasoning?: string

Reasoning of the metric result.

string_value?: string

The value of the metric as a string.

run_name?: string

Run name.

star_metric_result?: APIEvaluationMetricResult { error_description, metric_name, metric_value_type, 3 more }

error_description?: string

Error description if the metric could not be calculated.

metric_name?: string

Metric name

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"

number_value?: number

The value of the metric as a number.

formatdouble

reasoning?: string

Reasoning of the metric result.

string_value?: string

The value of the metric as a string.

started_at?: string

Run start time.

formatdate-time

status?: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | 6 more

Evaluation Run Statuses

Accepts one of the following:

"EVALUATION_RUN_STATUS_UNSPECIFIED"

"EVALUATION_RUN_QUEUED"

"EVALUATION_RUN_RUNNING_DATASET"

"EVALUATION_RUN_EVALUATING_RESULTS"

"EVALUATION_RUN_CANCELLING"

"EVALUATION_RUN_CANCELLED"

"EVALUATION_RUN_SUCCESSFUL"

"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"

"EVALUATION_RUN_FAILED"

test_case_description?: string

Test case description.

test_case_name?: string

Test case name.

test_case_uuid?: string

Test-case UUID.

test_case_version?: number

Test-case-version.

formatint64

AgentsEvaluation Test Cases

Create Evaluation Test Case.

client.agents.evaluationTestCases.create(EvaluationTestCaseCreateParams { dataset_uuid, description, metrics, 3 more } body?, RequestOptionsoptions?): EvaluationTestCaseCreateResponse { test_case_uuid }

post/v2/gen-ai/evaluation_test_cases

List Evaluation Test Cases

client.agents.evaluationTestCases.list(RequestOptionsoptions?): EvaluationTestCaseListResponse { evaluation_test_cases }

get/v2/gen-ai/evaluation_test_cases

List Evaluation Runs by Test Case

client.agents.evaluationTestCases.listEvaluationRuns(stringevaluationTestCaseUuid, EvaluationTestCaseListEvaluationRunsParams { evaluation_test_case_version } query?, RequestOptionsoptions?): EvaluationTestCaseListEvaluationRunsResponse { evaluation_runs }

get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs

Retrieve Information About an Existing Evaluation Test Case

client.agents.evaluationTestCases.retrieve(stringtestCaseUuid, EvaluationTestCaseRetrieveParams { evaluation_test_case_version } query?, RequestOptionsoptions?): EvaluationTestCaseRetrieveResponse { evaluation_test_case }

get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

Update an Evaluation Test Case.

client.agents.evaluationTestCases.update(stringtestCaseUuid, EvaluationTestCaseUpdateParams { dataset_uuid, description, metrics, 3 more } body?, RequestOptionsoptions?): EvaluationTestCaseUpdateResponse { test_case_uuid, version }

put/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

ModelsExpand Collapse

APIEvaluationTestCase { archived_at, created_at, created_by_user_email, 15 more }

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

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

AgentsFunctions

Add Function Route to an Agent

client.agents.functions.create(stringagentUuid, FunctionCreateParams { agent_uuid, description, faas_name, 4 more } body?, RequestOptionsoptions?): FunctionCreateResponse { agent }

post/v2/gen-ai/agents/{agent_uuid}/functions

Delete Function Route for an Agent

client.agents.functions.delete(stringfunctionUuid, FunctionDeleteParams { agent_uuid } params, RequestOptionsoptions?): FunctionDeleteResponse { agent }

delete/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

Update Function Route for an Agent

client.agents.functions.update(stringfunctionUuid, FunctionUpdateParams { body_agent_uuid, description, faas_name, 5 more } params, RequestOptionsoptions?): FunctionUpdateResponse { agent }

put/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

AgentsKnowledge Bases

Attach Knowledge Bases to an Agent

client.agents.knowledgeBases.attach(stringagentUuid, RequestOptionsoptions?): APILinkKnowledgeBaseOutput { agent }

post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases

Attach Knowledge Base to an Agent

client.agents.knowledgeBases.attachSingle(stringknowledgeBaseUuid, KnowledgeBaseAttachSingleParams { agent_uuid } params, RequestOptionsoptions?): APILinkKnowledgeBaseOutput { agent }

post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

Detach Knowledge Base from an Agent

client.agents.knowledgeBases.detach(stringknowledgeBaseUuid, KnowledgeBaseDetachParams { agent_uuid } params, RequestOptionsoptions?): KnowledgeBaseDetachResponse { agent }

delete/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

ModelsExpand Collapse

APILinkKnowledgeBaseOutput { agent }

Information about a linked knowledge base

agent?: 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

logo?: 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 }

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

logo?: 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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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

logo?: 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?: APIDeploymentVisibility

• VISIBILITY_UNKNOWN: The status of the deployment is unknown
• VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
• VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
• VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
• VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Accepts one of the following:

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

description?: 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 }

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 }

AgentsRoutes

Add Agent Route to an Agent

client.agents.routes.add(stringchildAgentUuid, RouteAddParams { body_parent_agent_uuid, child_agent_uuid, if_case, route_name } params, RequestOptionsoptions?): RouteAddResponse { child_agent_uuid, parent_agent_uuid }

post/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

Delete Agent Route for an Agent

client.agents.routes.delete(stringchildAgentUuid, RouteDeleteParams { parent_agent_uuid } params, RequestOptionsoptions?): RouteDeleteResponse { child_agent_uuid, parent_agent_uuid }

delete/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

Update Agent Route for an Agent

client.agents.routes.update(stringchildAgentUuid, RouteUpdateParams { body_parent_agent_uuid, child_agent_uuid, if_case, 2 more } params, RequestOptionsoptions?): RouteUpdateResponse { child_agent_uuid, parent_agent_uuid, rollback, uuid }

put/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

View Agent Routes

client.agents.routes.view(stringuuid, RequestOptionsoptions?): RouteViewResponse { children }

get/v2/gen-ai/agents/{uuid}/child_agents

AgentsVersions

List Agent Versions

client.agents.versions.list(stringuuid, VersionListParams { page, per_page } query?, RequestOptionsoptions?): VersionListResponse { agent_versions, links, meta }

get/v2/gen-ai/agents/{uuid}/versions

Rollback to Agent Version

client.agents.versions.update(stringpathUuid, VersionUpdateParams { body_uuid, version_hash } body?, RequestOptionsoptions?): VersionUpdateResponse { audit_header, version_hash }

put/v2/gen-ai/agents/{uuid}/versions