API Reference

Agents

Knowledge Bases

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Attach Knowledge Bases to an Agent

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

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

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

ParametersExpand Collapse

agentUuid string

ReturnsExpand Collapse

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

Attach Knowledge Bases to an Agent

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  apiLinkKnowledgeBaseOutput, err := client.Agents.KnowledgeBases.Attach(context.TODO(), `"123e4567-e89b-12d3-a456-426614174000"`)
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", apiLinkKnowledgeBaseOutput.Agent)
}

200 example

{
  "agent": {
    "anthropic_api_key": {
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "api_key_infos": [
      {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "secret_key": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "api_keys": [
      {
        "api_key": "example string"
      }
    ],
    "chatbot": {
      "allowed_domains": [
        "example string"
      ],
      "button_background_color": "example string",
      "logo": "example string",
      "name": "example name",
      "primary_color": "example string",
      "secondary_color": "example string",
      "starting_message": "example string"
    },
    "chatbot_identifiers": [
      {
        "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "child_agents": [],
    "conversation_logs_enabled": true,
    "created_at": "2023-01-01T00:00:00Z",
    "deployment": {
      "created_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "status": "STATUS_UNKNOWN",
      "updated_at": "2023-01-01T00:00:00Z",
      "url": "example string",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "visibility": "VISIBILITY_UNKNOWN"
    },
    "description": "example string",
    "functions": [
      {
        "api_key": "example string",
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "description": "example string",
        "faas_name": "example name",
        "faas_namespace": "example name",
        "input_schema": {},
        "name": "example name",
        "output_schema": {},
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "guardrails": [
      {
        "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "created_at": "2023-01-01T00:00:00Z",
        "default_response": "example string",
        "description": "example string",
        "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_attached": true,
        "is_default": true,
        "metadata": {},
        "name": "example name",
        "priority": 123,
        "type": "GUARDRAIL_TYPE_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "if_case": "example string",
    "instruction": "example string",
    "k": 123,
    "knowledge_bases": [
      {
        "added_to_agent_at": "2023-01-01T00:00:00Z",
        "created_at": "2023-01-01T00:00:00Z",
        "database_id": "123e4567-e89b-12d3-a456-426614174000",
        "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_public": true,
        "last_indexing_job": {
          "completed_datasources": 123,
          "created_at": "2023-01-01T00:00:00Z",
          "data_source_jobs": [
            {
              "completed_at": "2023-01-01T00:00:00Z",
              "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "error_details": "example string",
              "error_msg": "example string",
              "failed_item_count": "12345",
              "indexed_file_count": "12345",
              "indexed_item_count": "12345",
              "removed_item_count": "12345",
              "skipped_item_count": "12345",
              "started_at": "2023-01-01T00:00:00Z",
              "status": "DATA_SOURCE_STATUS_UNKNOWN",
              "total_bytes": "12345",
              "total_bytes_indexed": "12345",
              "total_file_count": "12345"
            }
          ],
          "data_source_uuids": [
            "example string"
          ],
          "finished_at": "2023-01-01T00:00:00Z",
          "is_report_available": true,
          "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "phase": "BATCH_JOB_PHASE_UNKNOWN",
          "started_at": "2023-01-01T00:00:00Z",
          "status": "INDEX_JOB_STATUS_UNKNOWN",
          "tokens": 123,
          "total_datasources": 123,
          "total_tokens": "12345",
          "updated_at": "2023-01-01T00:00:00Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "name": "example name",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "region": "example string",
        "tags": [
          "example string"
        ],
        "updated_at": "2023-01-01T00:00:00Z",
        "user_id": "user_id",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "logging_config": {
      "galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
      "galileo_project_name": "example name",
      "insights_enabled": true,
      "insights_enabled_at": "2023-01-01T00:00:00Z",
      "log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
      "log_stream_name": "example name"
    },
    "max_tokens": 123,
    "model": {
      "agreement": {
        "description": "example string",
        "name": "example name",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2023-01-01T00:00:00Z",
      "inference_name": "example name",
      "inference_version": "example string",
      "is_foundational": true,
      "kb_default_chunk_size": 123,
      "kb_max_chunk_size": 123,
      "kb_min_chunk_size": 123,
      "metadata": {},
      "name": "example name",
      "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "provider": "MODEL_PROVIDER_DIGITALOCEAN",
      "updated_at": "2023-01-01T00:00:00Z",
      "upload_complete": true,
      "url": "example string",
      "usecases": [
        "MODEL_USECASE_AGENT",
        "MODEL_USECASE_GUARDRAIL"
      ],
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "version": {
        "major": 123,
        "minor": 123,
        "patch": 123
      }
    },
    "model_provider_key": {
      "api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "models": [
        {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        }
      ],
      "name": "example name",
      "provider": "MODEL_PROVIDER_DIGITALOCEAN",
      "updated_at": "2023-01-01T00:00:00Z"
    },
    "name": "example name",
    "openai_api_key": {
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "models": [
        {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        }
      ],
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "parent_agents": [],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "provide_citations": true,
    "region": "example string",
    "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
    "route_created_at": "2023-01-01T00:00:00Z",
    "route_created_by": "12345",
    "route_name": "example name",
    "route_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "example string"
    ],
    "temperature": 123,
    "template": {
      "created_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "guardrails": [
        {
          "priority": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "instruction": "example string",
      "k": 123,
      "knowledge_bases": [
        {
          "added_to_agent_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "database_id": "123e4567-e89b-12d3-a456-426614174000",
          "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_public": true,
          "last_indexing_job": {
            "completed_datasources": 123,
            "created_at": "2023-01-01T00:00:00Z",
            "data_source_jobs": [
              {
                "completed_at": "2023-01-01T00:00:00Z",
                "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                "error_details": "example string",
                "error_msg": "example string",
                "failed_item_count": "12345",
                "indexed_file_count": "12345",
                "indexed_item_count": "12345",
                "removed_item_count": "12345",
                "skipped_item_count": "12345",
                "started_at": "2023-01-01T00:00:00Z",
                "status": "DATA_SOURCE_STATUS_UNKNOWN",
                "total_bytes": "12345",
                "total_bytes_indexed": "12345",
                "total_file_count": "12345"
              }
            ],
            "data_source_uuids": [
              "example string"
            ],
            "finished_at": "2023-01-01T00:00:00Z",
            "is_report_available": true,
            "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "phase": "BATCH_JOB_PHASE_UNKNOWN",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "INDEX_JOB_STATUS_UNKNOWN",
            "tokens": 123,
            "total_datasources": 123,
            "total_tokens": "12345",
            "updated_at": "2023-01-01T00:00:00Z",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "name": "example name",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "example string",
          "tags": [
            "example string"
          ],
          "updated_at": "2023-01-01T00:00:00Z",
          "user_id": "user_id",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
      "max_tokens": 123,
      "model": {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "kb_default_chunk_size": 123,
        "kb_max_chunk_size": 123,
        "kb_min_chunk_size": 123,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      },
      "name": "example name",
      "short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
      "summary": "example string",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
      "top_p": 123,
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "top_p": 123,
    "updated_at": "2023-01-01T00:00:00Z",
    "url": "example string",
    "user_id": "12345",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "version_hash": "example string",
    "vpc_egress_ips": [
      "example string"
    ],
    "vpc_uuid": "\"12345678-1234-1234-1234-123456789012\"",
    "workspace": {
      "agents": [],
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "created_by_email": "example@example.com",
      "deleted_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "evaluation_test_cases": [
        {
          "archived_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by_user_email": "example@example.com",
          "created_by_user_id": "12345",
          "dataset": {
            "created_at": "2023-01-01T00:00:00Z",
            "dataset_name": "example name",
            "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "file_size": "12345",
            "has_ground_truth": true,
            "row_count": 123
          },
          "dataset_name": "example name",
          "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "description": "example string",
          "latest_version_number_of_runs": 123,
          "metrics": [
            {
              "category": "METRIC_CATEGORY_UNSPECIFIED",
              "description": "example string",
              "inverted": true,
              "is_metric_goal": true,
              "metric_name": "example name",
              "metric_rank": 123,
              "metric_type": "METRIC_TYPE_UNSPECIFIED",
              "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
              "range_max": 123,
              "range_min": 123
            }
          ],
          "name": "example name",
          "star_metric": {
            "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "name": "example name",
            "success_threshold": 123,
            "success_threshold_pct": 123
          },
          "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "total_runs": 123,
          "updated_at": "2023-01-01T00:00:00Z",
          "updated_by_user_email": "example@example.com",
          "updated_by_user_id": "12345",
          "version": 123
        }
      ],
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Returns Examples

200 example

{
  "agent": {
    "anthropic_api_key": {
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "api_key_infos": [
      {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "secret_key": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "api_keys": [
      {
        "api_key": "example string"
      }
    ],
    "chatbot": {
      "allowed_domains": [
        "example string"
      ],
      "button_background_color": "example string",
      "logo": "example string",
      "name": "example name",
      "primary_color": "example string",
      "secondary_color": "example string",
      "starting_message": "example string"
    },
    "chatbot_identifiers": [
      {
        "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "child_agents": [],
    "conversation_logs_enabled": true,
    "created_at": "2023-01-01T00:00:00Z",
    "deployment": {
      "created_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "status": "STATUS_UNKNOWN",
      "updated_at": "2023-01-01T00:00:00Z",
      "url": "example string",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "visibility": "VISIBILITY_UNKNOWN"
    },
    "description": "example string",
    "functions": [
      {
        "api_key": "example string",
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "description": "example string",
        "faas_name": "example name",
        "faas_namespace": "example name",
        "input_schema": {},
        "name": "example name",
        "output_schema": {},
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "guardrails": [
      {
        "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "created_at": "2023-01-01T00:00:00Z",
        "default_response": "example string",
        "description": "example string",
        "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_attached": true,
        "is_default": true,
        "metadata": {},
        "name": "example name",
        "priority": 123,
        "type": "GUARDRAIL_TYPE_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "if_case": "example string",
    "instruction": "example string",
    "k": 123,
    "knowledge_bases": [
      {
        "added_to_agent_at": "2023-01-01T00:00:00Z",
        "created_at": "2023-01-01T00:00:00Z",
        "database_id": "123e4567-e89b-12d3-a456-426614174000",
        "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_public": true,
        "last_indexing_job": {
          "completed_datasources": 123,
          "created_at": "2023-01-01T00:00:00Z",
          "data_source_jobs": [
            {
              "completed_at": "2023-01-01T00:00:00Z",
              "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "error_details": "example string",
              "error_msg": "example string",
              "failed_item_count": "12345",
              "indexed_file_count": "12345",
              "indexed_item_count": "12345",
              "removed_item_count": "12345",
              "skipped_item_count": "12345",
              "started_at": "2023-01-01T00:00:00Z",
              "status": "DATA_SOURCE_STATUS_UNKNOWN",
              "total_bytes": "12345",
              "total_bytes_indexed": "12345",
              "total_file_count": "12345"
            }
          ],
          "data_source_uuids": [
            "example string"
          ],
          "finished_at": "2023-01-01T00:00:00Z",
          "is_report_available": true,
          "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "phase": "BATCH_JOB_PHASE_UNKNOWN",
          "started_at": "2023-01-01T00:00:00Z",
          "status": "INDEX_JOB_STATUS_UNKNOWN",
          "tokens": 123,
          "total_datasources": 123,
          "total_tokens": "12345",
          "updated_at": "2023-01-01T00:00:00Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "name": "example name",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "region": "example string",
        "tags": [
          "example string"
        ],
        "updated_at": "2023-01-01T00:00:00Z",
        "user_id": "user_id",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "logging_config": {
      "galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
      "galileo_project_name": "example name",
      "insights_enabled": true,
      "insights_enabled_at": "2023-01-01T00:00:00Z",
      "log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
      "log_stream_name": "example name"
    },
    "max_tokens": 123,
    "model": {
      "agreement": {
        "description": "example string",
        "name": "example name",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2023-01-01T00:00:00Z",
      "inference_name": "example name",
      "inference_version": "example string",
      "is_foundational": true,
      "kb_default_chunk_size": 123,
      "kb_max_chunk_size": 123,
      "kb_min_chunk_size": 123,
      "metadata": {},
      "name": "example name",
      "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "provider": "MODEL_PROVIDER_DIGITALOCEAN",
      "updated_at": "2023-01-01T00:00:00Z",
      "upload_complete": true,
      "url": "example string",
      "usecases": [
        "MODEL_USECASE_AGENT",
        "MODEL_USECASE_GUARDRAIL"
      ],
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "version": {
        "major": 123,
        "minor": 123,
        "patch": 123
      }
    },
    "model_provider_key": {
      "api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "models": [
        {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        }
      ],
      "name": "example name",
      "provider": "MODEL_PROVIDER_DIGITALOCEAN",
      "updated_at": "2023-01-01T00:00:00Z"
    },
    "name": "example name",
    "openai_api_key": {
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "models": [
        {
          "agreement": {
            "description": "example string",
            "name": "example name",
            "url": "example string",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created_at": "2023-01-01T00:00:00Z",
          "inference_name": "example name",
          "inference_version": "example string",
          "is_foundational": true,
          "kb_default_chunk_size": 123,
          "kb_max_chunk_size": 123,
          "kb_min_chunk_size": 123,
          "metadata": {},
          "name": "example name",
          "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "MODEL_PROVIDER_DIGITALOCEAN",
          "updated_at": "2023-01-01T00:00:00Z",
          "upload_complete": true,
          "url": "example string",
          "usecases": [
            "MODEL_USECASE_AGENT",
            "MODEL_USECASE_GUARDRAIL"
          ],
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "version": {
            "major": 123,
            "minor": 123,
            "patch": 123
          }
        }
      ],
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "parent_agents": [],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "provide_citations": true,
    "region": "example string",
    "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
    "route_created_at": "2023-01-01T00:00:00Z",
    "route_created_by": "12345",
    "route_name": "example name",
    "route_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "example string"
    ],
    "temperature": 123,
    "template": {
      "created_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "guardrails": [
        {
          "priority": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "instruction": "example string",
      "k": 123,
      "knowledge_bases": [
        {
          "added_to_agent_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "database_id": "123e4567-e89b-12d3-a456-426614174000",
          "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_public": true,
          "last_indexing_job": {
            "completed_datasources": 123,
            "created_at": "2023-01-01T00:00:00Z",
            "data_source_jobs": [
              {
                "completed_at": "2023-01-01T00:00:00Z",
                "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                "error_details": "example string",
                "error_msg": "example string",
                "failed_item_count": "12345",
                "indexed_file_count": "12345",
                "indexed_item_count": "12345",
                "removed_item_count": "12345",
                "skipped_item_count": "12345",
                "started_at": "2023-01-01T00:00:00Z",
                "status": "DATA_SOURCE_STATUS_UNKNOWN",
                "total_bytes": "12345",
                "total_bytes_indexed": "12345",
                "total_file_count": "12345"
              }
            ],
            "data_source_uuids": [
              "example string"
            ],
            "finished_at": "2023-01-01T00:00:00Z",
            "is_report_available": true,
            "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "phase": "BATCH_JOB_PHASE_UNKNOWN",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "INDEX_JOB_STATUS_UNKNOWN",
            "tokens": 123,
            "total_datasources": 123,
            "total_tokens": "12345",
            "updated_at": "2023-01-01T00:00:00Z",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          },
          "name": "example name",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "example string",
          "tags": [
            "example string"
          ],
          "updated_at": "2023-01-01T00:00:00Z",
          "user_id": "user_id",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
      "max_tokens": 123,
      "model": {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "kb_default_chunk_size": 123,
        "kb_max_chunk_size": 123,
        "kb_min_chunk_size": 123,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      },
      "name": "example name",
      "short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
      "summary": "example string",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
      "top_p": 123,
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "top_p": 123,
    "updated_at": "2023-01-01T00:00:00Z",
    "url": "example string",
    "user_id": "12345",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "version_hash": "example string",
    "vpc_egress_ips": [
      "example string"
    ],
    "vpc_uuid": "\"12345678-1234-1234-1234-123456789012\"",
    "workspace": {
      "agents": [],
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "created_by_email": "example@example.com",
      "deleted_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "evaluation_test_cases": [
        {
          "archived_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by_user_email": "example@example.com",
          "created_by_user_id": "12345",
          "dataset": {
            "created_at": "2023-01-01T00:00:00Z",
            "dataset_name": "example name",
            "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "file_size": "12345",
            "has_ground_truth": true,
            "row_count": 123
          },
          "dataset_name": "example name",
          "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "description": "example string",
          "latest_version_number_of_runs": 123,
          "metrics": [
            {
              "category": "METRIC_CATEGORY_UNSPECIFIED",
              "description": "example string",
              "inverted": true,
              "is_metric_goal": true,
              "metric_name": "example name",
              "metric_rank": 123,
              "metric_type": "METRIC_TYPE_UNSPECIFIED",
              "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
              "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
              "range_max": 123,
              "range_min": 123
            }
          ],
          "name": "example name",
          "star_metric": {
            "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "name": "example name",
            "success_threshold": 123,
            "success_threshold_pct": 123
          },
          "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "total_runs": 123,
          "updated_at": "2023-01-01T00:00:00Z",
          "updated_by_user_email": "example@example.com",
          "updated_by_user_id": "12345",
          "version": 123
        }
      ],
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}