API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Agents

List Agents

client.Agents.List(ctx, query) (*AgentListResponse, error)

get/v2/gen-ai/agents

Create an Agent

client.Agents.New(ctx, body) (*AgentNewResponse, error)

post/v2/gen-ai/agents

Retrieve an Existing Agent

client.Agents.Get(ctx, uuid) (*AgentGetResponse, error)

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

Update an Agent

client.Agents.Update(ctx, uuid, body) (*AgentUpdateResponse, error)

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

Delete an Agent

client.Agents.Delete(ctx, uuid) (*AgentDeleteResponse, error)

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

Update Agent Status

client.Agents.UpdateStatus(ctx, uuid, body) (*AgentUpdateStatusResponse, error)

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

Get Agent Usage

client.Agents.GetUsage(ctx, uuid, query) (*AgentGetUsageResponse, error)

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

ModelsExpand Collapse

type APIAgent struct{…}

An Agent

AnthropicAPIKey APIAnthropicAPIKeyInfooptional

Anthropic API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

APIKeyInfos []APIAgentAPIKeyInfooptional

Api key infos

CreatedAt Timeoptional

Creation date

formatdate-time

CreatedBy stringoptional

Created by

formatuint64

DeletedAt Timeoptional

Deleted date

formatdate-time

Name stringoptional

Name

SecretKey stringoptional

Uuid stringoptional

Uuid

APIKeys []APIAgentAPIKeyoptional

Api keys

APIKey stringoptional

Api key

Chatbot APIAgentChatbotoptional

A Chatbot

AllowedDomains []stringoptional

ButtonBackgroundColor stringoptional

Logo stringoptional

Name stringoptional

Name of chatbot

PrimaryColor stringoptional

SecondaryColor stringoptional

StartingMessage stringoptional

ChatbotIdentifiers []APIAgentChatbotIdentifieroptional

Chatbot identifiers

AgentChatbotIdentifier stringoptional

Agent chatbot identifier

ChildAgents []APIAgentoptional

Child agents

ConversationLogsEnabled booloptional

Whether conversation logs are enabled for the agent

CreatedAt Timeoptional

Creation date / time

formatdate-time

Deployment APIAgentDeploymentoptional

Description of deployment

CreatedAt Timeoptional

Creation date / time

formatdate-time

Name stringoptional

Name

Status APIAgentDeploymentStatusoptional

Accepts one of the following:

const APIAgentDeploymentStatusStatusUnknown APIAgentDeploymentStatus = "STATUS_UNKNOWN"

const APIAgentDeploymentStatusStatusWaitingForDeployment APIAgentDeploymentStatus = "STATUS_WAITING_FOR_DEPLOYMENT"

const APIAgentDeploymentStatusStatusDeploying APIAgentDeploymentStatus = "STATUS_DEPLOYING"

const APIAgentDeploymentStatusStatusRunning APIAgentDeploymentStatus = "STATUS_RUNNING"

const APIAgentDeploymentStatusStatusFailed APIAgentDeploymentStatus = "STATUS_FAILED"

const APIAgentDeploymentStatusStatusWaitingForUndeployment APIAgentDeploymentStatus = "STATUS_WAITING_FOR_UNDEPLOYMENT"

const APIAgentDeploymentStatusStatusUndeploying APIAgentDeploymentStatus = "STATUS_UNDEPLOYING"

const APIAgentDeploymentStatusStatusUndeploymentFailed APIAgentDeploymentStatus = "STATUS_UNDEPLOYMENT_FAILED"

const APIAgentDeploymentStatusStatusDeleted APIAgentDeploymentStatus = "STATUS_DELETED"

const APIAgentDeploymentStatusStatusBuilding APIAgentDeploymentStatus = "STATUS_BUILDING"

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Access your deployed agent here

Uuid stringoptional

Unique id

Visibility APIDeploymentVisibilityoptional

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

const APIDeploymentVisibilityVisibilityUnknown APIDeploymentVisibility = "VISIBILITY_UNKNOWN"

const APIDeploymentVisibilityVisibilityDisabled APIDeploymentVisibility = "VISIBILITY_DISABLED"

const APIDeploymentVisibilityVisibilityPlayground APIDeploymentVisibility = "VISIBILITY_PLAYGROUND"

const APIDeploymentVisibilityVisibilityPublic APIDeploymentVisibility = "VISIBILITY_PUBLIC"

const APIDeploymentVisibilityVisibilityPrivate APIDeploymentVisibility = "VISIBILITY_PRIVATE"

Description stringoptional

Description of agent

Functions []APIAgentFunctionoptional

APIKey stringoptional

Api key

CreatedAt Timeoptional

Creation date / time

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

Description stringoptional

Agent description

FaasName stringoptional

FaasNamespace stringoptional

InputSchema unknownoptional

Name stringoptional

Name

OutputSchema unknownoptional

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Download your agent here

Uuid stringoptional

Unique id

Guardrails []APIAgentGuardrailoptional

The guardrails the agent is attached to

AgentUuid stringoptional

CreatedAt Timeoptional

formatdate-time

DefaultResponse stringoptional

Description stringoptional

GuardrailUuid stringoptional

IsAttached booloptional

IsDefault booloptional

Metadata unknownoptional

Name stringoptional

Priority int64optional

formatint32

Type APIAgentGuardrailsTypeoptional

Accepts one of the following:

const APIAgentGuardrailsTypeGuardrailTypeUnknown APIAgentGuardrailsType = "GUARDRAIL_TYPE_UNKNOWN"

const APIAgentGuardrailsTypeGuardrailTypeJailbreak APIAgentGuardrailsType = "GUARDRAIL_TYPE_JAILBREAK"

const APIAgentGuardrailsTypeGuardrailTypeSensitiveData APIAgentGuardrailsType = "GUARDRAIL_TYPE_SENSITIVE_DATA"

const APIAgentGuardrailsTypeGuardrailTypeContentModeration APIAgentGuardrailsType = "GUARDRAIL_TYPE_CONTENT_MODERATION"

UpdatedAt Timeoptional

formatdate-time

Uuid stringoptional

IfCase stringoptional

Instruction stringoptional

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

K int64optional

formatint64

KnowledgeBases []APIKnowledgeBaseoptional

Knowledge bases

AddedToAgentAt Timeoptional

Time when the knowledge base was added to the agent

formatdate-time

CreatedAt Timeoptional

Creation date / time

formatdate-time

DatabaseID stringoptional

EmbeddingModelUuid stringoptional

IsPublic booloptional

Whether the knowledge base is public or not

LastIndexingJob APIIndexingJoboptional

IndexingJob description

CompletedDatasources int64optional

Number of datasources indexed completed

formatint64

CreatedAt Timeoptional

Creation date / time

formatdate-time

DataSourceJobs []APIIndexedDataSourceoptional

Details on Data Sources included in the Indexing Job

CompletedAt Timeoptional

Timestamp when data source completed indexing

formatdate-time

DataSourceUuid stringoptional

Uuid of the indexed data source

ErrorDetails stringoptional

A detailed error description

ErrorMsg stringoptional

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

FailedItemCount stringoptional

Total count of files that have failed

formatuint64

IndexedFileCount stringoptional

Total count of files that have been indexed

formatuint64

IndexedItemCount stringoptional

Total count of files that have been indexed

formatuint64

RemovedItemCount stringoptional

Total count of files that have been removed

formatuint64

SkippedItemCount stringoptional

Total count of files that have been skipped

formatuint64

StartedAt Timeoptional

Timestamp when data source started indexing

formatdate-time

Status APIIndexedDataSourceStatusoptional

Accepts one of the following:

const APIIndexedDataSourceStatusDataSourceStatusUnknown APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UNKNOWN"

const APIIndexedDataSourceStatusDataSourceStatusInProgress APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_IN_PROGRESS"

const APIIndexedDataSourceStatusDataSourceStatusUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusPartiallyUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusNotUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_NOT_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusFailed APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_FAILED"

const APIIndexedDataSourceStatusDataSourceStatusCancelled APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_CANCELLED"

TotalBytes stringoptional

Total size of files in data source in bytes

formatuint64

TotalBytesIndexed stringoptional

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

formatuint64

TotalFileCount stringoptional

Total file count in the data source

formatuint64

DataSourceUuids []stringoptional

FinishedAt Timeoptional

formatdate-time

IsReportAvailable booloptional

Boolean value to determine if the indexing job details are available

KnowledgeBaseUuid stringoptional

Knowledge base id

Phase APIIndexingJobPhaseoptional

Accepts one of the following:

const APIIndexingJobPhaseBatchJobPhaseUnknown APIIndexingJobPhase = "BATCH_JOB_PHASE_UNKNOWN"

const APIIndexingJobPhaseBatchJobPhasePending APIIndexingJobPhase = "BATCH_JOB_PHASE_PENDING"

const APIIndexingJobPhaseBatchJobPhaseRunning APIIndexingJobPhase = "BATCH_JOB_PHASE_RUNNING"

const APIIndexingJobPhaseBatchJobPhaseSucceeded APIIndexingJobPhase = "BATCH_JOB_PHASE_SUCCEEDED"

const APIIndexingJobPhaseBatchJobPhaseFailed APIIndexingJobPhase = "BATCH_JOB_PHASE_FAILED"

const APIIndexingJobPhaseBatchJobPhaseError APIIndexingJobPhase = "BATCH_JOB_PHASE_ERROR"

const APIIndexingJobPhaseBatchJobPhaseCancelled APIIndexingJobPhase = "BATCH_JOB_PHASE_CANCELLED"

StartedAt Timeoptional

formatdate-time

Status APIIndexingJobStatusoptional

Accepts one of the following:

const APIIndexingJobStatusIndexJobStatusUnknown APIIndexingJobStatus = "INDEX_JOB_STATUS_UNKNOWN"

const APIIndexingJobStatusIndexJobStatusPartial APIIndexingJobStatus = "INDEX_JOB_STATUS_PARTIAL"

const APIIndexingJobStatusIndexJobStatusInProgress APIIndexingJobStatus = "INDEX_JOB_STATUS_IN_PROGRESS"

const APIIndexingJobStatusIndexJobStatusCompleted APIIndexingJobStatus = "INDEX_JOB_STATUS_COMPLETED"

const APIIndexingJobStatusIndexJobStatusFailed APIIndexingJobStatus = "INDEX_JOB_STATUS_FAILED"

const APIIndexingJobStatusIndexJobStatusNoChanges APIIndexingJobStatus = "INDEX_JOB_STATUS_NO_CHANGES"

const APIIndexingJobStatusIndexJobStatusPending APIIndexingJobStatus = "INDEX_JOB_STATUS_PENDING"

const APIIndexingJobStatusIndexJobStatusCancelled APIIndexingJobStatus = "INDEX_JOB_STATUS_CANCELLED"

Tokens int64optional

Number of tokens [This field is deprecated]

formatint64

TotalDatasources int64optional

Number of datasources being indexed

formatint64

TotalTokens stringoptional

Total Tokens Consumed By the Indexing Job

formatuint64

UpdatedAt Timeoptional

Last modified

formatdate-time

Uuid stringoptional

Unique id

Name stringoptional

Name of knowledge base

ProjectID stringoptional

Region stringoptional

Region code

Tags []stringoptional

Tags to organize related resources

UpdatedAt Timeoptional

Last modified

formatdate-time

UserID stringoptional

Id of user that created the knowledge base

formatint64

Uuid stringoptional

Unique id for knowledge base

LoggingConfig APIAgentLoggingConfigoptional

GalileoProjectID stringoptional

Galileo project identifier

GalileoProjectName stringoptional

Name of the Galileo project

InsightsEnabled booloptional

Whether insights are enabled

InsightsEnabledAt Timeoptional

Timestamp when insights were enabled

formatdate-time

LogStreamID stringoptional

Identifier for the log stream

LogStreamName stringoptional

Name of the log stream

MaxTokens int64optional

formatint64

Model APIAgentModeloptional

Description of a Model

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

ModelProviderKey APIAgentModelProviderKeyoptional

APIKeyUuid stringoptional

API key ID

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Models []APIAgentModeloptional

Models supported by the openAI api key

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name of the key

Provider APIAgentModelProviderKeyProvideroptional

Accepts one of the following:

const APIAgentModelProviderKeyProviderModelProviderDigitalocean APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderKeyProviderModelProviderAnthropic APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderKeyProviderModelProviderOpenAI APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Name stringoptional

Agent name

OpenAIAPIKey APIOpenAIAPIKeyInfooptional

OpenAI API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Models []APIAgentModeloptional

Models supported by the openAI api key

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

ParentAgents []APIAgentoptional

Parent agents

ProjectID stringoptional

ProvideCitations booloptional

Whether the agent should provide in-response citations

Region stringoptional

Region code

RetrievalMethod APIRetrievalMethodoptional

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

const APIRetrievalMethodRetrievalMethodUnknown APIRetrievalMethod = "RETRIEVAL_METHOD_UNKNOWN"

const APIRetrievalMethodRetrievalMethodRewrite APIRetrievalMethod = "RETRIEVAL_METHOD_REWRITE"

const APIRetrievalMethodRetrievalMethodStepBack APIRetrievalMethod = "RETRIEVAL_METHOD_STEP_BACK"

const APIRetrievalMethodRetrievalMethodSubQueries APIRetrievalMethod = "RETRIEVAL_METHOD_SUB_QUERIES"

const APIRetrievalMethodRetrievalMethodNone APIRetrievalMethod = "RETRIEVAL_METHOD_NONE"

RouteCreatedAt Timeoptional

Creation of route date / time

formatdate-time

RouteCreatedBy stringoptional

formatuint64

RouteName stringoptional

Route name

RouteUuid stringoptional

Tags []stringoptional

Agent tag to organize related resources

Temperature float64optional

formatfloat

Template APIAgentTemplateoptional

Represents an AgentTemplate entity

CreatedAt Timeoptional

The agent template's creation date

formatdate-time

Description stringoptional

Deprecated - Use summary instead

Guardrails []APIAgentTemplateGuardrailoptional

List of guardrails associated with the agent template

Priority int64optional

Priority of the guardrail

formatint32

Uuid stringoptional

Uuid of the guardrail

Instruction stringoptional

Instructions for the agent template

K int64optional

The 'k' value for the agent template

formatint64

KnowledgeBases []APIKnowledgeBaseoptional

List of knowledge bases associated with the agent template

AddedToAgentAt Timeoptional

Time when the knowledge base was added to the agent

formatdate-time

CreatedAt Timeoptional

Creation date / time

formatdate-time

DatabaseID stringoptional

EmbeddingModelUuid stringoptional

IsPublic booloptional

Whether the knowledge base is public or not

LastIndexingJob APIIndexingJoboptional

IndexingJob description

CompletedDatasources int64optional

Number of datasources indexed completed

formatint64

CreatedAt Timeoptional

Creation date / time

formatdate-time

DataSourceJobs []APIIndexedDataSourceoptional

Details on Data Sources included in the Indexing Job

CompletedAt Timeoptional

Timestamp when data source completed indexing

formatdate-time

DataSourceUuid stringoptional

Uuid of the indexed data source

ErrorDetails stringoptional

A detailed error description

ErrorMsg stringoptional

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

FailedItemCount stringoptional

Total count of files that have failed

formatuint64

IndexedFileCount stringoptional

Total count of files that have been indexed

formatuint64

IndexedItemCount stringoptional

Total count of files that have been indexed

formatuint64

RemovedItemCount stringoptional

Total count of files that have been removed

formatuint64

SkippedItemCount stringoptional

Total count of files that have been skipped

formatuint64

StartedAt Timeoptional

Timestamp when data source started indexing

formatdate-time

Status APIIndexedDataSourceStatusoptional

Accepts one of the following:

const APIIndexedDataSourceStatusDataSourceStatusUnknown APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UNKNOWN"

const APIIndexedDataSourceStatusDataSourceStatusInProgress APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_IN_PROGRESS"

const APIIndexedDataSourceStatusDataSourceStatusUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusPartiallyUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusNotUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_NOT_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusFailed APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_FAILED"

const APIIndexedDataSourceStatusDataSourceStatusCancelled APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_CANCELLED"

TotalBytes stringoptional

Total size of files in data source in bytes

formatuint64

TotalBytesIndexed stringoptional

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

formatuint64

TotalFileCount stringoptional

Total file count in the data source

formatuint64

DataSourceUuids []stringoptional

FinishedAt Timeoptional

formatdate-time

IsReportAvailable booloptional

Boolean value to determine if the indexing job details are available

KnowledgeBaseUuid stringoptional

Knowledge base id

Phase APIIndexingJobPhaseoptional

Accepts one of the following:

const APIIndexingJobPhaseBatchJobPhaseUnknown APIIndexingJobPhase = "BATCH_JOB_PHASE_UNKNOWN"

const APIIndexingJobPhaseBatchJobPhasePending APIIndexingJobPhase = "BATCH_JOB_PHASE_PENDING"

const APIIndexingJobPhaseBatchJobPhaseRunning APIIndexingJobPhase = "BATCH_JOB_PHASE_RUNNING"

const APIIndexingJobPhaseBatchJobPhaseSucceeded APIIndexingJobPhase = "BATCH_JOB_PHASE_SUCCEEDED"

const APIIndexingJobPhaseBatchJobPhaseFailed APIIndexingJobPhase = "BATCH_JOB_PHASE_FAILED"

const APIIndexingJobPhaseBatchJobPhaseError APIIndexingJobPhase = "BATCH_JOB_PHASE_ERROR"

const APIIndexingJobPhaseBatchJobPhaseCancelled APIIndexingJobPhase = "BATCH_JOB_PHASE_CANCELLED"

StartedAt Timeoptional

formatdate-time

Status APIIndexingJobStatusoptional

Accepts one of the following:

const APIIndexingJobStatusIndexJobStatusUnknown APIIndexingJobStatus = "INDEX_JOB_STATUS_UNKNOWN"

const APIIndexingJobStatusIndexJobStatusPartial APIIndexingJobStatus = "INDEX_JOB_STATUS_PARTIAL"

const APIIndexingJobStatusIndexJobStatusInProgress APIIndexingJobStatus = "INDEX_JOB_STATUS_IN_PROGRESS"

const APIIndexingJobStatusIndexJobStatusCompleted APIIndexingJobStatus = "INDEX_JOB_STATUS_COMPLETED"

const APIIndexingJobStatusIndexJobStatusFailed APIIndexingJobStatus = "INDEX_JOB_STATUS_FAILED"

const APIIndexingJobStatusIndexJobStatusNoChanges APIIndexingJobStatus = "INDEX_JOB_STATUS_NO_CHANGES"

const APIIndexingJobStatusIndexJobStatusPending APIIndexingJobStatus = "INDEX_JOB_STATUS_PENDING"

const APIIndexingJobStatusIndexJobStatusCancelled APIIndexingJobStatus = "INDEX_JOB_STATUS_CANCELLED"

Tokens int64optional

Number of tokens [This field is deprecated]

formatint64

TotalDatasources int64optional

Number of datasources being indexed

formatint64

TotalTokens stringoptional

Total Tokens Consumed By the Indexing Job

formatuint64

UpdatedAt Timeoptional

Last modified

formatdate-time

Uuid stringoptional

Unique id

Name stringoptional

Name of knowledge base

ProjectID stringoptional

Region stringoptional

Region code

Tags []stringoptional

Tags to organize related resources

UpdatedAt Timeoptional

Last modified

formatdate-time

UserID stringoptional

Id of user that created the knowledge base

formatint64

Uuid stringoptional

Unique id for knowledge base

LongDescription stringoptional

The long description of the agent template

MaxTokens int64optional

The max_tokens setting for the agent template

formatint64

Model APIAgentModeloptional

Description of a Model

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name of the agent template

ShortDescription stringoptional

The short description of the agent template

Summary stringoptional

The summary of the agent template

Tags []stringoptional

List of tags associated with the agent template

Temperature float64optional

The temperature setting for the agent template

formatfloat

TemplateType APIAgentTemplateTemplateTypeoptional

• AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
• AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template

Accepts one of the following:

const APIAgentTemplateTemplateTypeAgentTemplateTypeStandard APIAgentTemplateTemplateType = "AGENT_TEMPLATE_TYPE_STANDARD"

const APIAgentTemplateTemplateTypeAgentTemplateTypeOneClick APIAgentTemplateTemplateType = "AGENT_TEMPLATE_TYPE_ONE_CLICK"

TopP float64optional

The top_p setting for the agent template

formatfloat

UpdatedAt Timeoptional

The agent template's last updated date

formatdate-time

Uuid stringoptional

Unique id

TopP float64optional

formatfloat

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Access your agent under this url

UserID stringoptional

Id of user that created the agent

formatuint64

Uuid stringoptional

Unique agent id

VersionHash stringoptional

The latest version of the agent

VpcEgressIPs []stringoptional

VPC Egress IPs

VpcUuid stringoptional

Workspace APIWorkspaceoptional

type APIAgentAPIKeyInfo struct{…}

Agent API Key Info

CreatedAt Timeoptional

Creation date

formatdate-time

CreatedBy stringoptional

Created by

formatuint64

DeletedAt Timeoptional

Deleted date

formatdate-time

Name stringoptional

Name

SecretKey stringoptional

Uuid stringoptional

Uuid

type APIAgentModel struct{…}

Description of a Model

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

type APIAnthropicAPIKeyInfo struct{…}

Anthropic API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

type APIDeploymentVisibility string

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

const APIDeploymentVisibilityVisibilityUnknown APIDeploymentVisibility = "VISIBILITY_UNKNOWN"

const APIDeploymentVisibilityVisibilityDisabled APIDeploymentVisibility = "VISIBILITY_DISABLED"

const APIDeploymentVisibilityVisibilityPlayground APIDeploymentVisibility = "VISIBILITY_PLAYGROUND"

const APIDeploymentVisibilityVisibilityPublic APIDeploymentVisibility = "VISIBILITY_PUBLIC"

const APIDeploymentVisibilityVisibilityPrivate APIDeploymentVisibility = "VISIBILITY_PRIVATE"

type APIOpenAIAPIKeyInfo struct{…}

OpenAI API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Models []APIAgentModeloptional

Models supported by the openAI api key

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

type APIRetrievalMethod string

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

const APIRetrievalMethodRetrievalMethodUnknown APIRetrievalMethod = "RETRIEVAL_METHOD_UNKNOWN"

const APIRetrievalMethodRetrievalMethodRewrite APIRetrievalMethod = "RETRIEVAL_METHOD_REWRITE"

const APIRetrievalMethodRetrievalMethodStepBack APIRetrievalMethod = "RETRIEVAL_METHOD_STEP_BACK"

const APIRetrievalMethodRetrievalMethodSubQueries APIRetrievalMethod = "RETRIEVAL_METHOD_SUB_QUERIES"

const APIRetrievalMethodRetrievalMethodNone APIRetrievalMethod = "RETRIEVAL_METHOD_NONE"

type APIWorkspace struct{…}

Agents []APIAgentoptional

Agents

CreatedAt Timeoptional

Creation date

formatdate-time

CreatedBy stringoptional

The id of user who created this workspace

formatuint64

CreatedByEmail stringoptional

The email of the user who created this workspace

DeletedAt Timeoptional

Deleted date

formatdate-time

Description stringoptional

Description of the workspace

EvaluationTestCases []APIEvaluationTestCaseoptional

Evaluations

ArchivedAt Timeoptional

formatdate-time

CreatedAt Timeoptional

formatdate-time

CreatedByUserEmail stringoptional

CreatedByUserID stringoptional

formatuint64

Dataset APIEvaluationTestCaseDatasetoptional

CreatedAt Timeoptional

Time created at.

formatdate-time

DatasetName stringoptional

Name of the dataset.

DatasetUuid stringoptional

UUID of the dataset.

FileSize stringoptional

The size of the dataset uploaded file in bytes.

formatuint64

HasGroundTruth booloptional

Does the dataset have a ground truth column?

RowCount int64optional

Number of rows in the dataset.

formatint64

DatasetName stringoptional

DatasetUuid stringoptional

Description stringoptional

LatestVersionNumberOfRuns int64optional

formatint32

Metrics []APIEvaluationMetricoptional

Category APIEvaluationMetricCategoryoptional

Accepts one of the following:

const APIEvaluationMetricCategoryMetricCategoryUnspecified APIEvaluationMetricCategory = "METRIC_CATEGORY_UNSPECIFIED"

const APIEvaluationMetricCategoryMetricCategoryCorrectness APIEvaluationMetricCategory = "METRIC_CATEGORY_CORRECTNESS"

const APIEvaluationMetricCategoryMetricCategoryUserOutcomes APIEvaluationMetricCategory = "METRIC_CATEGORY_USER_OUTCOMES"

const APIEvaluationMetricCategoryMetricCategorySafetyAndSecurity APIEvaluationMetricCategory = "METRIC_CATEGORY_SAFETY_AND_SECURITY"

const APIEvaluationMetricCategoryMetricCategoryContextQuality APIEvaluationMetricCategory = "METRIC_CATEGORY_CONTEXT_QUALITY"

const APIEvaluationMetricCategoryMetricCategoryModelFit APIEvaluationMetricCategory = "METRIC_CATEGORY_MODEL_FIT"

Description stringoptional

Inverted booloptional

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

IsMetricGoal booloptional

MetricName stringoptional

MetricRank int64optional

formatint64

MetricType APIEvaluationMetricMetricTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricTypeMetricTypeUnspecified APIEvaluationMetricMetricType = "METRIC_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricTypeMetricTypeGeneralQuality APIEvaluationMetricMetricType = "METRIC_TYPE_GENERAL_QUALITY"

const APIEvaluationMetricMetricTypeMetricTypeRagAndTool APIEvaluationMetricMetricType = "METRIC_TYPE_RAG_AND_TOOL"

MetricUuid stringoptional

MetricValueType APIEvaluationMetricMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricValueTypeMetricValueTypeNumber APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricMetricValueTypeMetricValueTypeString APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricMetricValueTypeMetricValueTypePercentage APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

RangeMax float64optional

The maximum value for the metric.

formatfloat

RangeMin float64optional

The minimum value for the metric.

formatfloat

Name stringoptional

StarMetric APIStarMetricoptional

MetricUuid stringoptional

Name stringoptional

SuccessThreshold float64optional

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

formatfloat

SuccessThresholdPct int64optional

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

formatint32

TestCaseUuid stringoptional

TotalRuns int64optional

formatint32

UpdatedAt Timeoptional

formatdate-time

UpdatedByUserEmail stringoptional

UpdatedByUserID stringoptional

formatuint64

Version int64optional

formatint64

Name stringoptional

Name of the workspace

UpdatedAt Timeoptional

Update date

formatdate-time

Uuid stringoptional

Unique id

AgentsAPI Keys

List Agent API Keys

client.Agents.APIKeys.List(ctx, agentUuid, query) (*AgentAPIKeyListResponse, error)

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

Create an Agent API Key

client.Agents.APIKeys.New(ctx, agentUuid, body) (*AgentAPIKeyNewResponse, error)

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

Update API Key for an Agent

client.Agents.APIKeys.Update(ctx, agentUuid, apiKeyUuid, body) (*AgentAPIKeyUpdateResponse, error)

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

Delete API Key for an Agent

client.Agents.APIKeys.Delete(ctx, agentUuid, apiKeyUuid) (*AgentAPIKeyDeleteResponse, error)

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

Regenerate API Key for an Agent

client.Agents.APIKeys.Regenerate(ctx, agentUuid, apiKeyUuid) (*AgentAPIKeyRegenerateResponse, error)

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

AgentsChat

AgentsChatCompletions

Creates a model response for the given chat conversation.

client.Agents.Chat.Completions.New(ctx, body) (*AgentChatCompletionNewResponse, error)

post/chat/completions?agent=true

AgentsEvaluation Metrics

List Evaluation Metrics

client.Agents.EvaluationMetrics.List(ctx) (*AgentEvaluationMetricListResponse, error)

get/v2/gen-ai/evaluation_metrics

List Datacenter Regions

client.Agents.EvaluationMetrics.ListRegions(ctx, query) (*AgentEvaluationMetricListRegionsResponse, error)

get/v2/gen-ai/regions

AgentsEvaluation MetricsWorkspaces

List Workspaces

client.Agents.EvaluationMetrics.Workspaces.List(ctx) (*AgentEvaluationMetricWorkspaceListResponse, error)

get/v2/gen-ai/workspaces

Create a Workspace

client.Agents.EvaluationMetrics.Workspaces.New(ctx, body) (*AgentEvaluationMetricWorkspaceNewResponse, error)

post/v2/gen-ai/workspaces

Retrieve an Existing Workspace

client.Agents.EvaluationMetrics.Workspaces.Get(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceGetResponse, error)

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

Delete a Workspace

client.Agents.EvaluationMetrics.Workspaces.Delete(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceDeleteResponse, error)

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

Update a Workspace

client.Agents.EvaluationMetrics.Workspaces.Update(ctx, workspaceUuid, body) (*AgentEvaluationMetricWorkspaceUpdateResponse, error)

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

List Evaluation Test Cases by Workspace

client.Agents.EvaluationMetrics.Workspaces.ListEvaluationTestCases(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceListEvaluationTestCasesResponse, error)

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

AgentsEvaluation MetricsWorkspacesAgents

List agents by Workspace

client.Agents.EvaluationMetrics.Workspaces.Agents.List(ctx, workspaceUuid, query) (*AgentEvaluationMetricWorkspaceAgentListResponse, error)

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

Move Agents to a Workspace

client.Agents.EvaluationMetrics.Workspaces.Agents.Move(ctx, workspaceUuid, body) (*AgentEvaluationMetricWorkspaceAgentMoveResponse, error)

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

AgentsEvaluation MetricsAnthropic

AgentsEvaluation MetricsAnthropicKeys

List Anthropic API Keys

client.Agents.EvaluationMetrics.Anthropic.Keys.List(ctx, query) (*AgentEvaluationMetricAnthropicKeyListResponse, error)

get/v2/gen-ai/anthropic/keys

Create Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.New(ctx, body) (*AgentEvaluationMetricAnthropicKeyNewResponse, error)

post/v2/gen-ai/anthropic/keys

Get Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Get(ctx, apiKeyUuid) (*AgentEvaluationMetricAnthropicKeyGetResponse, error)

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

Update Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Update(ctx, apiKeyUuid, body) (*AgentEvaluationMetricAnthropicKeyUpdateResponse, error)

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

Delete Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Delete(ctx, apiKeyUuid) (*AgentEvaluationMetricAnthropicKeyDeleteResponse, error)

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

List agents by Anthropic key

client.Agents.EvaluationMetrics.Anthropic.Keys.ListAgents(ctx, uuid, query) (*AgentEvaluationMetricAnthropicKeyListAgentsResponse, error)

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

AgentsEvaluation MetricsOpenAI

AgentsEvaluation MetricsOpenAIKeys

List OpenAI API Keys

client.Agents.EvaluationMetrics.OpenAI.Keys.List(ctx, query) (*AgentEvaluationMetricOpenAIKeyListResponse, error)

get/v2/gen-ai/openai/keys

Create OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.New(ctx, body) (*AgentEvaluationMetricOpenAIKeyNewResponse, error)

post/v2/gen-ai/openai/keys

Get OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Get(ctx, apiKeyUuid) (*AgentEvaluationMetricOpenAIKeyGetResponse, error)

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

Update OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Update(ctx, apiKeyUuid, body) (*AgentEvaluationMetricOpenAIKeyUpdateResponse, error)

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

Delete OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Delete(ctx, apiKeyUuid) (*AgentEvaluationMetricOpenAIKeyDeleteResponse, error)

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

List agents by OpenAI key

client.Agents.EvaluationMetrics.OpenAI.Keys.ListAgents(ctx, uuid, query) (*AgentEvaluationMetricOpenAIKeyListAgentsResponse, error)

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

AgentsEvaluation MetricsOauth2

Get Oauth2 URL

client.Agents.EvaluationMetrics.Oauth2.GenerateURL(ctx, query) (*AgentEvaluationMetricOauth2GenerateURLResponse, error)

get/v2/gen-ai/oauth2/url

AgentsEvaluation MetricsOauth2Dropbox

Get Oauth2 Dropbox Tokens

client.Agents.EvaluationMetrics.Oauth2.Dropbox.NewTokens(ctx, body) (*AgentEvaluationMetricOauth2DropboxNewTokensResponse, error)

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

AgentsEvaluation MetricsScheduled Indexing

Create scheduled indexing for knowledge base

client.Agents.EvaluationMetrics.ScheduledIndexing.New(ctx, body) (*AgentEvaluationMetricScheduledIndexingNewResponse, error)

post/v2/gen-ai/scheduled-indexing

Get Scheduled Indexing for Knowledge Base

client.Agents.EvaluationMetrics.ScheduledIndexing.Get(ctx, knowledgeBaseUuid) (*AgentEvaluationMetricScheduledIndexingGetResponse, error)

get/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}

Delete Scheduled Indexing

client.Agents.EvaluationMetrics.ScheduledIndexing.Delete(ctx, uuid) (*AgentEvaluationMetricScheduledIndexingDeleteResponse, error)

delete/v2/gen-ai/scheduled-indexing/{uuid}

AgentsEvaluation Runs

Run an Evaluation Test Case

client.Agents.EvaluationRuns.New(ctx, body) (*AgentEvaluationRunNewResponse, error)

post/v2/gen-ai/evaluation_runs

Retrieve Information About an Existing Evaluation Run

client.Agents.EvaluationRuns.Get(ctx, evaluationRunUuid) (*AgentEvaluationRunGetResponse, error)

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

Retrieve Results of an Evaluation Run

client.Agents.EvaluationRuns.ListResults(ctx, evaluationRunUuid, query) (*AgentEvaluationRunListResultsResponse, error)

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

Retrieve Results of an Evaluation Run Prompt

client.Agents.EvaluationRuns.GetResults(ctx, evaluationRunUuid, promptID) (*AgentEvaluationRunGetResultsResponse, error)

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

ModelsExpand Collapse

type APIEvaluationMetric struct{…}

Category APIEvaluationMetricCategoryoptional

Accepts one of the following:

const APIEvaluationMetricCategoryMetricCategoryUnspecified APIEvaluationMetricCategory = "METRIC_CATEGORY_UNSPECIFIED"

const APIEvaluationMetricCategoryMetricCategoryCorrectness APIEvaluationMetricCategory = "METRIC_CATEGORY_CORRECTNESS"

const APIEvaluationMetricCategoryMetricCategoryUserOutcomes APIEvaluationMetricCategory = "METRIC_CATEGORY_USER_OUTCOMES"

const APIEvaluationMetricCategoryMetricCategorySafetyAndSecurity APIEvaluationMetricCategory = "METRIC_CATEGORY_SAFETY_AND_SECURITY"

const APIEvaluationMetricCategoryMetricCategoryContextQuality APIEvaluationMetricCategory = "METRIC_CATEGORY_CONTEXT_QUALITY"

const APIEvaluationMetricCategoryMetricCategoryModelFit APIEvaluationMetricCategory = "METRIC_CATEGORY_MODEL_FIT"

Description stringoptional

Inverted booloptional

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

IsMetricGoal booloptional

MetricName stringoptional

MetricRank int64optional

formatint64

MetricType APIEvaluationMetricMetricTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricTypeMetricTypeUnspecified APIEvaluationMetricMetricType = "METRIC_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricTypeMetricTypeGeneralQuality APIEvaluationMetricMetricType = "METRIC_TYPE_GENERAL_QUALITY"

const APIEvaluationMetricMetricTypeMetricTypeRagAndTool APIEvaluationMetricMetricType = "METRIC_TYPE_RAG_AND_TOOL"

MetricUuid stringoptional

MetricValueType APIEvaluationMetricMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricValueTypeMetricValueTypeNumber APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricMetricValueTypeMetricValueTypeString APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricMetricValueTypeMetricValueTypePercentage APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

RangeMax float64optional

The maximum value for the metric.

formatfloat

RangeMin float64optional

The minimum value for the metric.

formatfloat

type APIEvaluationMetricResult struct{…}

ErrorDescription stringoptional

Error description if the metric could not be calculated.

MetricName stringoptional

Metric name

MetricValueType APIEvaluationMetricResultMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeNumber APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeString APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypePercentage APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

NumberValue float64optional

The value of the metric as a number.

formatdouble

Reasoning stringoptional

Reasoning of the metric result.

StringValue stringoptional

The value of the metric as a string.

type APIEvaluationPrompt struct{…}

EvaluationTraceSpans []APIEvaluationPromptEvaluationTraceSpanoptional

The evaluated trace spans.

CreatedAt Timeoptional

When the span was created

formatdate-time

Input unknownoptional

Input data for the span (flexible structure - can be messages array, string, etc.)

Name stringoptional

Name/identifier for the span

Output unknownoptional

Output data from the span (flexible structure - can be message, string, etc.)

RetrieverChunks []APIEvaluationPromptEvaluationTraceSpansRetrieverChunkoptional

Any retriever span chunks that were included as part of the span.

ChunkUsagePct float64optional

The usage percentage of the chunk.

formatdouble

ChunkUsed booloptional

Indicates if the chunk was used in the prompt.

IndexUuid stringoptional

The index uuid (Knowledge Base) of the chunk.

SourceName stringoptional

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

Text stringoptional

Text content of the chunk.

SpanLevelMetricResults []APIEvaluationMetricResultoptional

The span-level metric results.

ErrorDescription stringoptional

Error description if the metric could not be calculated.

MetricName stringoptional

Metric name

MetricValueType APIEvaluationMetricResultMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeNumber APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeString APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypePercentage APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

NumberValue float64optional

The value of the metric as a number.

formatdouble

Reasoning stringoptional

Reasoning of the metric result.

StringValue stringoptional

The value of the metric as a string.

Type APIEvaluationPromptEvaluationTraceSpansTypeoptional

Types of spans in a trace

Accepts one of the following:

const APIEvaluationPromptEvaluationTraceSpansTypeTraceSpanTypeUnknown APIEvaluationPromptEvaluationTraceSpansType = "TRACE_SPAN_TYPE_UNKNOWN"

const APIEvaluationPromptEvaluationTraceSpansTypeTraceSpanTypeLlm APIEvaluationPromptEvaluationTraceSpansType = "TRACE_SPAN_TYPE_LLM"

const APIEvaluationPromptEvaluationTraceSpansTypeTraceSpanTypeRetriever APIEvaluationPromptEvaluationTraceSpansType = "TRACE_SPAN_TYPE_RETRIEVER"

const APIEvaluationPromptEvaluationTraceSpansTypeTraceSpanTypeTool APIEvaluationPromptEvaluationTraceSpansType = "TRACE_SPAN_TYPE_TOOL"

GroundTruth stringoptional

The ground truth for the prompt.

Input stringoptional

InputTokens stringoptional

The number of input tokens used in the prompt.

formatuint64

Output stringoptional

OutputTokens stringoptional

The number of output tokens used in the prompt.

formatuint64

PromptChunks []APIEvaluationPromptPromptChunkoptional

The list of prompt chunks.

ChunkUsagePct float64optional

The usage percentage of the chunk.

formatdouble

ChunkUsed booloptional

Indicates if the chunk was used in the prompt.

IndexUuid stringoptional

The index uuid (Knowledge Base) of the chunk.

SourceName stringoptional

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

Text stringoptional

Text content of the chunk.

PromptID int64optional

Prompt ID

formatint64

PromptLevelMetricResults []APIEvaluationMetricResultoptional

The metric results for the prompt.

ErrorDescription stringoptional

Error description if the metric could not be calculated.

MetricName stringoptional

Metric name

MetricValueType APIEvaluationMetricResultMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeNumber APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeString APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypePercentage APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

NumberValue float64optional

The value of the metric as a number.

formatdouble

Reasoning stringoptional

Reasoning of the metric result.

StringValue stringoptional

The value of the metric as a string.

TraceID stringoptional

The trace id for the prompt.

type APIEvaluationRun struct{…}

AgentDeleted booloptional

Whether agent is deleted

AgentDeploymentName stringoptional

The agent deployment name

AgentName stringoptional

Agent name

AgentUuid stringoptional

Agent UUID.

AgentVersionHash stringoptional

Version hash

AgentWorkspaceUuid stringoptional

Agent workspace uuid

CreatedByUserEmail stringoptional

CreatedByUserID stringoptional

formatuint64

ErrorDescription stringoptional

The error description

EvaluationRunUuid stringoptional

Evaluation run UUID.

EvaluationTestCaseWorkspaceUuid stringoptional

Evaluation test case workspace uuid

FinishedAt Timeoptional

Run end time.

formatdate-time

PassStatus booloptional

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

QueuedAt Timeoptional

Run queued time.

formatdate-time

RunLevelMetricResults []APIEvaluationMetricResultoptional

ErrorDescription stringoptional

Error description if the metric could not be calculated.

MetricName stringoptional

Metric name

MetricValueType APIEvaluationMetricResultMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeNumber APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeString APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypePercentage APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

NumberValue float64optional

The value of the metric as a number.

formatdouble

Reasoning stringoptional

Reasoning of the metric result.

StringValue stringoptional

The value of the metric as a string.

RunName stringoptional

Run name.

StarMetricResult APIEvaluationMetricResultoptional

ErrorDescription stringoptional

Error description if the metric could not be calculated.

MetricName stringoptional

Metric name

MetricValueType APIEvaluationMetricResultMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeNumber APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypeString APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricResultMetricValueTypeMetricValueTypePercentage APIEvaluationMetricResultMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

NumberValue float64optional

The value of the metric as a number.

formatdouble

Reasoning stringoptional

Reasoning of the metric result.

StringValue stringoptional

The value of the metric as a string.

StartedAt Timeoptional

Run start time.

formatdate-time

Status APIEvaluationRunStatusoptional

Evaluation Run Statuses

Accepts one of the following:

const APIEvaluationRunStatusEvaluationRunStatusUnspecified APIEvaluationRunStatus = "EVALUATION_RUN_STATUS_UNSPECIFIED"

const APIEvaluationRunStatusEvaluationRunQueued APIEvaluationRunStatus = "EVALUATION_RUN_QUEUED"

const APIEvaluationRunStatusEvaluationRunRunningDataset APIEvaluationRunStatus = "EVALUATION_RUN_RUNNING_DATASET"

const APIEvaluationRunStatusEvaluationRunEvaluatingResults APIEvaluationRunStatus = "EVALUATION_RUN_EVALUATING_RESULTS"

const APIEvaluationRunStatusEvaluationRunCancelling APIEvaluationRunStatus = "EVALUATION_RUN_CANCELLING"

const APIEvaluationRunStatusEvaluationRunCancelled APIEvaluationRunStatus = "EVALUATION_RUN_CANCELLED"

const APIEvaluationRunStatusEvaluationRunSuccessful APIEvaluationRunStatus = "EVALUATION_RUN_SUCCESSFUL"

const APIEvaluationRunStatusEvaluationRunPartiallySuccessful APIEvaluationRunStatus = "EVALUATION_RUN_PARTIALLY_SUCCESSFUL"

const APIEvaluationRunStatusEvaluationRunFailed APIEvaluationRunStatus = "EVALUATION_RUN_FAILED"

TestCaseDescription stringoptional

Test case description.

TestCaseName stringoptional

Test case name.

TestCaseUuid stringoptional

Test-case UUID.

TestCaseVersion int64optional

Test-case-version.

formatint64

AgentsEvaluation Test Cases

List Evaluation Test Cases

client.Agents.EvaluationTestCases.List(ctx) (*AgentEvaluationTestCaseListResponse, error)

get/v2/gen-ai/evaluation_test_cases

Create Evaluation Test Case.

client.Agents.EvaluationTestCases.New(ctx, body) (*AgentEvaluationTestCaseNewResponse, error)

post/v2/gen-ai/evaluation_test_cases

List Evaluation Runs by Test Case

client.Agents.EvaluationTestCases.ListEvaluationRuns(ctx, evaluationTestCaseUuid, query) (*AgentEvaluationTestCaseListEvaluationRunsResponse, error)

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

Retrieve Information About an Existing Evaluation Test Case

client.Agents.EvaluationTestCases.Get(ctx, testCaseUuid, query) (*AgentEvaluationTestCaseGetResponse, error)

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

Update an Evaluation Test Case.

client.Agents.EvaluationTestCases.Update(ctx, testCaseUuid, body) (*AgentEvaluationTestCaseUpdateResponse, error)

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

ModelsExpand Collapse

type APIEvaluationTestCase struct{…}

ArchivedAt Timeoptional

formatdate-time

CreatedAt Timeoptional

formatdate-time

CreatedByUserEmail stringoptional

CreatedByUserID stringoptional

formatuint64

Dataset APIEvaluationTestCaseDatasetoptional

CreatedAt Timeoptional

Time created at.

formatdate-time

DatasetName stringoptional

Name of the dataset.

DatasetUuid stringoptional

UUID of the dataset.

FileSize stringoptional

The size of the dataset uploaded file in bytes.

formatuint64

HasGroundTruth booloptional

Does the dataset have a ground truth column?

RowCount int64optional

Number of rows in the dataset.

formatint64

DatasetName stringoptional

DatasetUuid stringoptional

Description stringoptional

LatestVersionNumberOfRuns int64optional

formatint32

Metrics []APIEvaluationMetricoptional

Category APIEvaluationMetricCategoryoptional

Accepts one of the following:

const APIEvaluationMetricCategoryMetricCategoryUnspecified APIEvaluationMetricCategory = "METRIC_CATEGORY_UNSPECIFIED"

const APIEvaluationMetricCategoryMetricCategoryCorrectness APIEvaluationMetricCategory = "METRIC_CATEGORY_CORRECTNESS"

const APIEvaluationMetricCategoryMetricCategoryUserOutcomes APIEvaluationMetricCategory = "METRIC_CATEGORY_USER_OUTCOMES"

const APIEvaluationMetricCategoryMetricCategorySafetyAndSecurity APIEvaluationMetricCategory = "METRIC_CATEGORY_SAFETY_AND_SECURITY"

const APIEvaluationMetricCategoryMetricCategoryContextQuality APIEvaluationMetricCategory = "METRIC_CATEGORY_CONTEXT_QUALITY"

const APIEvaluationMetricCategoryMetricCategoryModelFit APIEvaluationMetricCategory = "METRIC_CATEGORY_MODEL_FIT"

Description stringoptional

Inverted booloptional

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

IsMetricGoal booloptional

MetricName stringoptional

MetricRank int64optional

formatint64

MetricType APIEvaluationMetricMetricTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricTypeMetricTypeUnspecified APIEvaluationMetricMetricType = "METRIC_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricTypeMetricTypeGeneralQuality APIEvaluationMetricMetricType = "METRIC_TYPE_GENERAL_QUALITY"

const APIEvaluationMetricMetricTypeMetricTypeRagAndTool APIEvaluationMetricMetricType = "METRIC_TYPE_RAG_AND_TOOL"

MetricUuid stringoptional

MetricValueType APIEvaluationMetricMetricValueTypeoptional

Accepts one of the following:

const APIEvaluationMetricMetricValueTypeMetricValueTypeUnspecified APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_UNSPECIFIED"

const APIEvaluationMetricMetricValueTypeMetricValueTypeNumber APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_NUMBER"

const APIEvaluationMetricMetricValueTypeMetricValueTypeString APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_STRING"

const APIEvaluationMetricMetricValueTypeMetricValueTypePercentage APIEvaluationMetricMetricValueType = "METRIC_VALUE_TYPE_PERCENTAGE"

RangeMax float64optional

The maximum value for the metric.

formatfloat

RangeMin float64optional

The minimum value for the metric.

formatfloat

Name stringoptional

StarMetric APIStarMetricoptional

MetricUuid stringoptional

Name stringoptional

SuccessThreshold float64optional

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

formatfloat

SuccessThresholdPct int64optional

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

formatint32

TestCaseUuid stringoptional

TotalRuns int64optional

formatint32

UpdatedAt Timeoptional

formatdate-time

UpdatedByUserEmail stringoptional

UpdatedByUserID stringoptional

formatuint64

Version int64optional

formatint64

type APIStarMetric struct{…}

MetricUuid stringoptional

Name stringoptional

SuccessThreshold float64optional

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

formatfloat

SuccessThresholdPct int64optional

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

formatint32

AgentsEvaluation Datasets

Create Presigned URLs for Evaluation Dataset File Upload

client.Agents.EvaluationDatasets.NewFileUploadPresignedURLs(ctx, body) (*AgentEvaluationDatasetNewFileUploadPresignedURLsResponse, error)

post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls

Create Evaluation Dataset

client.Agents.EvaluationDatasets.New(ctx, body) (*AgentEvaluationDatasetNewResponse, error)

post/v2/gen-ai/evaluation_datasets

AgentsFunctions

Add Function Route to an Agent

client.Agents.Functions.New(ctx, agentUuid, body) (*AgentFunctionNewResponse, error)

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

Update Function Route for an Agent

client.Agents.Functions.Update(ctx, agentUuid, functionUuid, body) (*AgentFunctionUpdateResponse, error)

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

Delete Function Route for an Agent

client.Agents.Functions.Delete(ctx, agentUuid, functionUuid) (*AgentFunctionDeleteResponse, error)

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

AgentsVersions

List Agent Versions

client.Agents.Versions.List(ctx, uuid, query) (*AgentVersionListResponse, error)

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

Rollback to Agent Version

client.Agents.Versions.Update(ctx, uuid, body) (*AgentVersionUpdateResponse, error)

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

AgentsKnowledge Bases

Attach Knowledge Bases to an Agent

client.Agents.KnowledgeBases.Attach(ctx, agentUuid) (*APILinkKnowledgeBaseOutput, error)

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

Attach Knowledge Base to an Agent

client.Agents.KnowledgeBases.AttachSingle(ctx, agentUuid, knowledgeBaseUuid) (*APILinkKnowledgeBaseOutput, error)

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

Detach Knowledge Base from an Agent

client.Agents.KnowledgeBases.Detach(ctx, agentUuid, knowledgeBaseUuid) (*AgentKnowledgeBaseDetachResponse, error)

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

ModelsExpand Collapse

type APILinkKnowledgeBaseOutput struct{…}

Information about a linked knowledge base

Agent APIAgentoptional

An Agent

AnthropicAPIKey APIAnthropicAPIKeyInfooptional

Anthropic API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

APIKeyInfos []APIAgentAPIKeyInfooptional

Api key infos

CreatedAt Timeoptional

Creation date

formatdate-time

CreatedBy stringoptional

Created by

formatuint64

DeletedAt Timeoptional

Deleted date

formatdate-time

Name stringoptional

Name

SecretKey stringoptional

Uuid stringoptional

Uuid

APIKeys []APIAgentAPIKeyoptional

Api keys

APIKey stringoptional

Api key

Chatbot APIAgentChatbotoptional

A Chatbot

AllowedDomains []stringoptional

ButtonBackgroundColor stringoptional

Logo stringoptional

Name stringoptional

Name of chatbot

PrimaryColor stringoptional

SecondaryColor stringoptional

StartingMessage stringoptional

ChatbotIdentifiers []APIAgentChatbotIdentifieroptional

Chatbot identifiers

AgentChatbotIdentifier stringoptional

Agent chatbot identifier

ChildAgents []APIAgentoptional

Child agents

ConversationLogsEnabled booloptional

Whether conversation logs are enabled for the agent

CreatedAt Timeoptional

Creation date / time

formatdate-time

Deployment APIAgentDeploymentoptional

Description of deployment

CreatedAt Timeoptional

Creation date / time

formatdate-time

Name stringoptional

Name

Status APIAgentDeploymentStatusoptional

Accepts one of the following:

const APIAgentDeploymentStatusStatusUnknown APIAgentDeploymentStatus = "STATUS_UNKNOWN"

const APIAgentDeploymentStatusStatusWaitingForDeployment APIAgentDeploymentStatus = "STATUS_WAITING_FOR_DEPLOYMENT"

const APIAgentDeploymentStatusStatusDeploying APIAgentDeploymentStatus = "STATUS_DEPLOYING"

const APIAgentDeploymentStatusStatusRunning APIAgentDeploymentStatus = "STATUS_RUNNING"

const APIAgentDeploymentStatusStatusFailed APIAgentDeploymentStatus = "STATUS_FAILED"

const APIAgentDeploymentStatusStatusWaitingForUndeployment APIAgentDeploymentStatus = "STATUS_WAITING_FOR_UNDEPLOYMENT"

const APIAgentDeploymentStatusStatusUndeploying APIAgentDeploymentStatus = "STATUS_UNDEPLOYING"

const APIAgentDeploymentStatusStatusUndeploymentFailed APIAgentDeploymentStatus = "STATUS_UNDEPLOYMENT_FAILED"

const APIAgentDeploymentStatusStatusDeleted APIAgentDeploymentStatus = "STATUS_DELETED"

const APIAgentDeploymentStatusStatusBuilding APIAgentDeploymentStatus = "STATUS_BUILDING"

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Access your deployed agent here

Uuid stringoptional

Unique id

Visibility APIDeploymentVisibilityoptional

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

const APIDeploymentVisibilityVisibilityUnknown APIDeploymentVisibility = "VISIBILITY_UNKNOWN"

const APIDeploymentVisibilityVisibilityDisabled APIDeploymentVisibility = "VISIBILITY_DISABLED"

const APIDeploymentVisibilityVisibilityPlayground APIDeploymentVisibility = "VISIBILITY_PLAYGROUND"

const APIDeploymentVisibilityVisibilityPublic APIDeploymentVisibility = "VISIBILITY_PUBLIC"

const APIDeploymentVisibilityVisibilityPrivate APIDeploymentVisibility = "VISIBILITY_PRIVATE"

Description stringoptional

Description of agent

Functions []APIAgentFunctionoptional

APIKey stringoptional

Api key

CreatedAt Timeoptional

Creation date / time

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

Description stringoptional

Agent description

FaasName stringoptional

FaasNamespace stringoptional

InputSchema unknownoptional

Name stringoptional

Name

OutputSchema unknownoptional

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Download your agent here

Uuid stringoptional

Unique id

Guardrails []APIAgentGuardrailoptional

The guardrails the agent is attached to

AgentUuid stringoptional

CreatedAt Timeoptional

formatdate-time

DefaultResponse stringoptional

Description stringoptional

GuardrailUuid stringoptional

IsAttached booloptional

IsDefault booloptional

Metadata unknownoptional

Name stringoptional

Priority int64optional

formatint32

Type APIAgentGuardrailsTypeoptional

Accepts one of the following:

const APIAgentGuardrailsTypeGuardrailTypeUnknown APIAgentGuardrailsType = "GUARDRAIL_TYPE_UNKNOWN"

const APIAgentGuardrailsTypeGuardrailTypeJailbreak APIAgentGuardrailsType = "GUARDRAIL_TYPE_JAILBREAK"

const APIAgentGuardrailsTypeGuardrailTypeSensitiveData APIAgentGuardrailsType = "GUARDRAIL_TYPE_SENSITIVE_DATA"

const APIAgentGuardrailsTypeGuardrailTypeContentModeration APIAgentGuardrailsType = "GUARDRAIL_TYPE_CONTENT_MODERATION"

UpdatedAt Timeoptional

formatdate-time

Uuid stringoptional

IfCase stringoptional

Instruction stringoptional

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

K int64optional

formatint64

KnowledgeBases []APIKnowledgeBaseoptional

Knowledge bases

AddedToAgentAt Timeoptional

Time when the knowledge base was added to the agent

formatdate-time

CreatedAt Timeoptional

Creation date / time

formatdate-time

DatabaseID stringoptional

EmbeddingModelUuid stringoptional

IsPublic booloptional

Whether the knowledge base is public or not

LastIndexingJob APIIndexingJoboptional

IndexingJob description

CompletedDatasources int64optional

Number of datasources indexed completed

formatint64

CreatedAt Timeoptional

Creation date / time

formatdate-time

DataSourceJobs []APIIndexedDataSourceoptional

Details on Data Sources included in the Indexing Job

CompletedAt Timeoptional

Timestamp when data source completed indexing

formatdate-time

DataSourceUuid stringoptional

Uuid of the indexed data source

ErrorDetails stringoptional

A detailed error description

ErrorMsg stringoptional

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

FailedItemCount stringoptional

Total count of files that have failed

formatuint64

IndexedFileCount stringoptional

Total count of files that have been indexed

formatuint64

IndexedItemCount stringoptional

Total count of files that have been indexed

formatuint64

RemovedItemCount stringoptional

Total count of files that have been removed

formatuint64

SkippedItemCount stringoptional

Total count of files that have been skipped

formatuint64

StartedAt Timeoptional

Timestamp when data source started indexing

formatdate-time

Status APIIndexedDataSourceStatusoptional

Accepts one of the following:

const APIIndexedDataSourceStatusDataSourceStatusUnknown APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UNKNOWN"

const APIIndexedDataSourceStatusDataSourceStatusInProgress APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_IN_PROGRESS"

const APIIndexedDataSourceStatusDataSourceStatusUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusPartiallyUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusNotUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_NOT_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusFailed APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_FAILED"

const APIIndexedDataSourceStatusDataSourceStatusCancelled APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_CANCELLED"

TotalBytes stringoptional

Total size of files in data source in bytes

formatuint64

TotalBytesIndexed stringoptional

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

formatuint64

TotalFileCount stringoptional

Total file count in the data source

formatuint64

DataSourceUuids []stringoptional

FinishedAt Timeoptional

formatdate-time

IsReportAvailable booloptional

Boolean value to determine if the indexing job details are available

KnowledgeBaseUuid stringoptional

Knowledge base id

Phase APIIndexingJobPhaseoptional

Accepts one of the following:

const APIIndexingJobPhaseBatchJobPhaseUnknown APIIndexingJobPhase = "BATCH_JOB_PHASE_UNKNOWN"

const APIIndexingJobPhaseBatchJobPhasePending APIIndexingJobPhase = "BATCH_JOB_PHASE_PENDING"

const APIIndexingJobPhaseBatchJobPhaseRunning APIIndexingJobPhase = "BATCH_JOB_PHASE_RUNNING"

const APIIndexingJobPhaseBatchJobPhaseSucceeded APIIndexingJobPhase = "BATCH_JOB_PHASE_SUCCEEDED"

const APIIndexingJobPhaseBatchJobPhaseFailed APIIndexingJobPhase = "BATCH_JOB_PHASE_FAILED"

const APIIndexingJobPhaseBatchJobPhaseError APIIndexingJobPhase = "BATCH_JOB_PHASE_ERROR"

const APIIndexingJobPhaseBatchJobPhaseCancelled APIIndexingJobPhase = "BATCH_JOB_PHASE_CANCELLED"

StartedAt Timeoptional

formatdate-time

Status APIIndexingJobStatusoptional

Accepts one of the following:

const APIIndexingJobStatusIndexJobStatusUnknown APIIndexingJobStatus = "INDEX_JOB_STATUS_UNKNOWN"

const APIIndexingJobStatusIndexJobStatusPartial APIIndexingJobStatus = "INDEX_JOB_STATUS_PARTIAL"

const APIIndexingJobStatusIndexJobStatusInProgress APIIndexingJobStatus = "INDEX_JOB_STATUS_IN_PROGRESS"

const APIIndexingJobStatusIndexJobStatusCompleted APIIndexingJobStatus = "INDEX_JOB_STATUS_COMPLETED"

const APIIndexingJobStatusIndexJobStatusFailed APIIndexingJobStatus = "INDEX_JOB_STATUS_FAILED"

const APIIndexingJobStatusIndexJobStatusNoChanges APIIndexingJobStatus = "INDEX_JOB_STATUS_NO_CHANGES"

const APIIndexingJobStatusIndexJobStatusPending APIIndexingJobStatus = "INDEX_JOB_STATUS_PENDING"

const APIIndexingJobStatusIndexJobStatusCancelled APIIndexingJobStatus = "INDEX_JOB_STATUS_CANCELLED"

Tokens int64optional

Number of tokens [This field is deprecated]

formatint64

TotalDatasources int64optional

Number of datasources being indexed

formatint64

TotalTokens stringoptional

Total Tokens Consumed By the Indexing Job

formatuint64

UpdatedAt Timeoptional

Last modified

formatdate-time

Uuid stringoptional

Unique id

Name stringoptional

Name of knowledge base

ProjectID stringoptional

Region stringoptional

Region code

Tags []stringoptional

Tags to organize related resources

UpdatedAt Timeoptional

Last modified

formatdate-time

UserID stringoptional

Id of user that created the knowledge base

formatint64

Uuid stringoptional

Unique id for knowledge base

LoggingConfig APIAgentLoggingConfigoptional

GalileoProjectID stringoptional

Galileo project identifier

GalileoProjectName stringoptional

Name of the Galileo project

InsightsEnabled booloptional

Whether insights are enabled

InsightsEnabledAt Timeoptional

Timestamp when insights were enabled

formatdate-time

LogStreamID stringoptional

Identifier for the log stream

LogStreamName stringoptional

Name of the log stream

MaxTokens int64optional

formatint64

Model APIAgentModeloptional

Description of a Model

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

ModelProviderKey APIAgentModelProviderKeyoptional

APIKeyUuid stringoptional

API key ID

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Models []APIAgentModeloptional

Models supported by the openAI api key

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name of the key

Provider APIAgentModelProviderKeyProvideroptional

Accepts one of the following:

const APIAgentModelProviderKeyProviderModelProviderDigitalocean APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderKeyProviderModelProviderAnthropic APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderKeyProviderModelProviderOpenAI APIAgentModelProviderKeyProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Name stringoptional

Agent name

OpenAIAPIKey APIOpenAIAPIKeyInfooptional

OpenAI API Key Info

CreatedAt Timeoptional

Key creation date

formatdate-time

CreatedBy stringoptional

Created by user id from DO

formatuint64

DeletedAt Timeoptional

Key deleted date

formatdate-time

Models []APIAgentModeloptional

Models supported by the openAI api key

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name

UpdatedAt Timeoptional

Key last updated date

formatdate-time

Uuid stringoptional

Uuid

ParentAgents []APIAgentoptional

Parent agents

ProjectID stringoptional

ProvideCitations booloptional

Whether the agent should provide in-response citations

Region stringoptional

Region code

RetrievalMethod APIRetrievalMethodoptional

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

const APIRetrievalMethodRetrievalMethodUnknown APIRetrievalMethod = "RETRIEVAL_METHOD_UNKNOWN"

const APIRetrievalMethodRetrievalMethodRewrite APIRetrievalMethod = "RETRIEVAL_METHOD_REWRITE"

const APIRetrievalMethodRetrievalMethodStepBack APIRetrievalMethod = "RETRIEVAL_METHOD_STEP_BACK"

const APIRetrievalMethodRetrievalMethodSubQueries APIRetrievalMethod = "RETRIEVAL_METHOD_SUB_QUERIES"

const APIRetrievalMethodRetrievalMethodNone APIRetrievalMethod = "RETRIEVAL_METHOD_NONE"

RouteCreatedAt Timeoptional

Creation of route date / time

formatdate-time

RouteCreatedBy stringoptional

formatuint64

RouteName stringoptional

Route name

RouteUuid stringoptional

Tags []stringoptional

Agent tag to organize related resources

Temperature float64optional

formatfloat

Template APIAgentTemplateoptional

Represents an AgentTemplate entity

CreatedAt Timeoptional

The agent template's creation date

formatdate-time

Description stringoptional

Deprecated - Use summary instead

Guardrails []APIAgentTemplateGuardrailoptional

List of guardrails associated with the agent template

Priority int64optional

Priority of the guardrail

formatint32

Uuid stringoptional

Uuid of the guardrail

Instruction stringoptional

Instructions for the agent template

K int64optional

The 'k' value for the agent template

formatint64

KnowledgeBases []APIKnowledgeBaseoptional

List of knowledge bases associated with the agent template

AddedToAgentAt Timeoptional

Time when the knowledge base was added to the agent

formatdate-time

CreatedAt Timeoptional

Creation date / time

formatdate-time

DatabaseID stringoptional

EmbeddingModelUuid stringoptional

IsPublic booloptional

Whether the knowledge base is public or not

LastIndexingJob APIIndexingJoboptional

IndexingJob description

CompletedDatasources int64optional

Number of datasources indexed completed

formatint64

CreatedAt Timeoptional

Creation date / time

formatdate-time

DataSourceJobs []APIIndexedDataSourceoptional

Details on Data Sources included in the Indexing Job

CompletedAt Timeoptional

Timestamp when data source completed indexing

formatdate-time

DataSourceUuid stringoptional

Uuid of the indexed data source

ErrorDetails stringoptional

A detailed error description

ErrorMsg stringoptional

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

FailedItemCount stringoptional

Total count of files that have failed

formatuint64

IndexedFileCount stringoptional

Total count of files that have been indexed

formatuint64

IndexedItemCount stringoptional

Total count of files that have been indexed

formatuint64

RemovedItemCount stringoptional

Total count of files that have been removed

formatuint64

SkippedItemCount stringoptional

Total count of files that have been skipped

formatuint64

StartedAt Timeoptional

Timestamp when data source started indexing

formatdate-time

Status APIIndexedDataSourceStatusoptional

Accepts one of the following:

const APIIndexedDataSourceStatusDataSourceStatusUnknown APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UNKNOWN"

const APIIndexedDataSourceStatusDataSourceStatusInProgress APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_IN_PROGRESS"

const APIIndexedDataSourceStatusDataSourceStatusUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusPartiallyUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusNotUpdated APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_NOT_UPDATED"

const APIIndexedDataSourceStatusDataSourceStatusFailed APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_FAILED"

const APIIndexedDataSourceStatusDataSourceStatusCancelled APIIndexedDataSourceStatus = "DATA_SOURCE_STATUS_CANCELLED"

TotalBytes stringoptional

Total size of files in data source in bytes

formatuint64

TotalBytesIndexed stringoptional

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

formatuint64

TotalFileCount stringoptional

Total file count in the data source

formatuint64

DataSourceUuids []stringoptional

FinishedAt Timeoptional

formatdate-time

IsReportAvailable booloptional

Boolean value to determine if the indexing job details are available

KnowledgeBaseUuid stringoptional

Knowledge base id

Phase APIIndexingJobPhaseoptional

Accepts one of the following:

const APIIndexingJobPhaseBatchJobPhaseUnknown APIIndexingJobPhase = "BATCH_JOB_PHASE_UNKNOWN"

const APIIndexingJobPhaseBatchJobPhasePending APIIndexingJobPhase = "BATCH_JOB_PHASE_PENDING"

const APIIndexingJobPhaseBatchJobPhaseRunning APIIndexingJobPhase = "BATCH_JOB_PHASE_RUNNING"

const APIIndexingJobPhaseBatchJobPhaseSucceeded APIIndexingJobPhase = "BATCH_JOB_PHASE_SUCCEEDED"

const APIIndexingJobPhaseBatchJobPhaseFailed APIIndexingJobPhase = "BATCH_JOB_PHASE_FAILED"

const APIIndexingJobPhaseBatchJobPhaseError APIIndexingJobPhase = "BATCH_JOB_PHASE_ERROR"

const APIIndexingJobPhaseBatchJobPhaseCancelled APIIndexingJobPhase = "BATCH_JOB_PHASE_CANCELLED"

StartedAt Timeoptional

formatdate-time

Status APIIndexingJobStatusoptional

Accepts one of the following:

const APIIndexingJobStatusIndexJobStatusUnknown APIIndexingJobStatus = "INDEX_JOB_STATUS_UNKNOWN"

const APIIndexingJobStatusIndexJobStatusPartial APIIndexingJobStatus = "INDEX_JOB_STATUS_PARTIAL"

const APIIndexingJobStatusIndexJobStatusInProgress APIIndexingJobStatus = "INDEX_JOB_STATUS_IN_PROGRESS"

const APIIndexingJobStatusIndexJobStatusCompleted APIIndexingJobStatus = "INDEX_JOB_STATUS_COMPLETED"

const APIIndexingJobStatusIndexJobStatusFailed APIIndexingJobStatus = "INDEX_JOB_STATUS_FAILED"

const APIIndexingJobStatusIndexJobStatusNoChanges APIIndexingJobStatus = "INDEX_JOB_STATUS_NO_CHANGES"

const APIIndexingJobStatusIndexJobStatusPending APIIndexingJobStatus = "INDEX_JOB_STATUS_PENDING"

const APIIndexingJobStatusIndexJobStatusCancelled APIIndexingJobStatus = "INDEX_JOB_STATUS_CANCELLED"

Tokens int64optional

Number of tokens [This field is deprecated]

formatint64

TotalDatasources int64optional

Number of datasources being indexed

formatint64

TotalTokens stringoptional

Total Tokens Consumed By the Indexing Job

formatuint64

UpdatedAt Timeoptional

Last modified

formatdate-time

Uuid stringoptional

Unique id

Name stringoptional

Name of knowledge base

ProjectID stringoptional

Region stringoptional

Region code

Tags []stringoptional

Tags to organize related resources

UpdatedAt Timeoptional

Last modified

formatdate-time

UserID stringoptional

Id of user that created the knowledge base

formatint64

Uuid stringoptional

Unique id for knowledge base

LongDescription stringoptional

The long description of the agent template

MaxTokens int64optional

The max_tokens setting for the agent template

formatint64

Model APIAgentModeloptional

Description of a Model

Agreement APIAgreementoptional

Agreement Description

Description stringoptional

Name stringoptional

URL stringoptional

Uuid stringoptional

CreatedAt Timeoptional

Creation date / time

formatdate-time

InferenceName stringoptional

Internally used name

InferenceVersion stringoptional

Internally used version

IsFoundational booloptional

True if it is a foundational model provided by do

KBDefaultChunkSize int64optional

Default chunking size limit to show in UI

formatint64

KBMaxChunkSize int64optional

Maximum chunk size limit of model

formatint64

KBMinChunkSize int64optional

Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase

formatint64

Metadata unknownoptional

Additional meta data

Name stringoptional

Name of the model

ParentUuid stringoptional

Unique id of the model, this model is based on

Provider APIAgentModelProvideroptional

Accepts one of the following:

const APIAgentModelProviderModelProviderDigitalocean APIAgentModelProvider = "MODEL_PROVIDER_DIGITALOCEAN"

const APIAgentModelProviderModelProviderAnthropic APIAgentModelProvider = "MODEL_PROVIDER_ANTHROPIC"

const APIAgentModelProviderModelProviderOpenAI APIAgentModelProvider = "MODEL_PROVIDER_OPENAI"

UpdatedAt Timeoptional

Last modified

formatdate-time

UploadComplete booloptional

Model has been fully uploaded

URL stringoptional

Download url

Usecases []APIAgentModelUsecaseoptional

Usecases of the model

Accepts one of the following:

const APIAgentModelUsecaseModelUsecaseUnknown APIAgentModelUsecase = "MODEL_USECASE_UNKNOWN"

const APIAgentModelUsecaseModelUsecaseAgent APIAgentModelUsecase = "MODEL_USECASE_AGENT"

const APIAgentModelUsecaseModelUsecaseFinetuned APIAgentModelUsecase = "MODEL_USECASE_FINETUNED"

const APIAgentModelUsecaseModelUsecaseKnowledgebase APIAgentModelUsecase = "MODEL_USECASE_KNOWLEDGEBASE"

const APIAgentModelUsecaseModelUsecaseGuardrail APIAgentModelUsecase = "MODEL_USECASE_GUARDRAIL"

const APIAgentModelUsecaseModelUsecaseReasoning APIAgentModelUsecase = "MODEL_USECASE_REASONING"

const APIAgentModelUsecaseModelUsecaseServerless APIAgentModelUsecase = "MODEL_USECASE_SERVERLESS"

Uuid stringoptional

Unique id

Version APIModelVersionoptional

Version Information about a Model

Major int64optional

Major version number

formatint64

Minor int64optional

Minor version number

formatint64

Patch int64optional

Patch version number

formatint64

Name stringoptional

Name of the agent template

ShortDescription stringoptional

The short description of the agent template

Summary stringoptional

The summary of the agent template

Tags []stringoptional

List of tags associated with the agent template

Temperature float64optional

The temperature setting for the agent template

formatfloat

TemplateType APIAgentTemplateTemplateTypeoptional

• AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
• AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template

Accepts one of the following:

const APIAgentTemplateTemplateTypeAgentTemplateTypeStandard APIAgentTemplateTemplateType = "AGENT_TEMPLATE_TYPE_STANDARD"

const APIAgentTemplateTemplateTypeAgentTemplateTypeOneClick APIAgentTemplateTemplateType = "AGENT_TEMPLATE_TYPE_ONE_CLICK"

TopP float64optional

The top_p setting for the agent template

formatfloat

UpdatedAt Timeoptional

The agent template's last updated date

formatdate-time

Uuid stringoptional

Unique id

TopP float64optional

formatfloat

UpdatedAt Timeoptional

Last modified

formatdate-time

URL stringoptional

Access your agent under this url

UserID stringoptional

Id of user that created the agent

formatuint64

Uuid stringoptional

Unique agent id

VersionHash stringoptional

The latest version of the agent

VpcEgressIPs []stringoptional

VPC Egress IPs

VpcUuid stringoptional

Workspace APIWorkspaceoptional

AgentsRoutes

Update Agent Route for an Agent

client.Agents.Routes.Update(ctx, parentAgentUuid, childAgentUuid, body) (*AgentRouteUpdateResponse, error)

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

Add Agent Route to an Agent

client.Agents.Routes.Add(ctx, parentAgentUuid, childAgentUuid, body) (*AgentRouteAddResponse, error)

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

Delete Agent Route for an Agent

client.Agents.Routes.Delete(ctx, parentAgentUuid, childAgentUuid) (*AgentRouteDeleteResponse, error)

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

View Agent Routes

client.Agents.Routes.View(ctx, uuid) (*AgentRouteViewResponse, error)

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