# Evaluation Metrics ## List `client.agents.evaluationMetrics.list(RequestOptionsoptions?): EvaluationMetricListResponse` **get** `/v2/gen-ai/evaluation_metrics` To list all evaluation metrics, send a GET request to `/v2/gen-ai/evaluation_metrics`. ### Returns - `EvaluationMetricListResponse` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationMetrics = await client.agents.evaluationMetrics.list(); console.log(evaluationMetrics.metrics); ``` ## List Regions `client.agents.evaluationMetrics.listRegions(EvaluationMetricListRegionsParamsquery?, RequestOptionsoptions?): EvaluationMetricListRegionsResponse` **get** `/v2/gen-ai/regions` To list all datacenter regions, send a GET request to `/v2/gen-ai/regions`. ### Parameters - `query: EvaluationMetricListRegionsParams` - `serves_batch?: boolean` Include datacenters that are capable of running batch jobs. - `serves_inference?: boolean` Include datacenters that serve inference. ### Returns - `EvaluationMetricListRegionsResponse` Region Codes - `regions?: Array` Region code - `inference_url?: string` Url for inference server - `region?: string` Region code - `serves_batch?: boolean` This datacenter is capable of running batch jobs - `serves_inference?: boolean` This datacenter is capable of serving inference - `stream_inference_url?: string` The url for the inference streaming server ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.listRegions(); console.log(response.regions); ``` # Workspaces ## Create `client.agents.evaluationMetrics.workspaces.create(WorkspaceCreateParamsbody?, RequestOptionsoptions?): WorkspaceCreateResponse` **post** `/v2/gen-ai/workspaces` To create a new workspace, send a POST request to `/v2/gen-ai/workspaces`. The response body contains a JSON object with the newly created workspace object. ### Parameters - `body: WorkspaceCreateParams` - `agent_uuids?: Array` Ids of the agents(s) to attach to the workspace - `description?: string` Description of the workspace - `name?: string` Name of the workspace ### Returns - `WorkspaceCreateResponse` - `workspace?: APIWorkspace` - `agents?: Array` Agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `created_at?: string` Creation date - `created_by?: string` The id of user who created this workspace - `created_by_email?: string` The email of the user who created this workspace - `deleted_at?: string` Deleted date - `description?: string` Description of the workspace - `evaluation_test_cases?: Array` Evaluations - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` - `name?: string` Name of the workspace - `updated_at?: string` Update date - `uuid?: string` Unique id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const workspace = await client.agents.evaluationMetrics.workspaces.create(); console.log(workspace.workspace); ``` ## Retrieve `client.agents.evaluationMetrics.workspaces.retrieve(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceRetrieveResponse` **get** `/v2/gen-ai/workspaces/{workspace_uuid}` To retrieve details of a workspace, GET request to `/v2/gen-ai/workspaces/{workspace_uuid}`. The response body is a JSON object containing the workspace. ### Parameters - `workspaceUuid: string` ### Returns - `WorkspaceRetrieveResponse` - `workspace?: APIWorkspace` - `agents?: Array` Agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `created_at?: string` Creation date - `created_by?: string` The id of user who created this workspace - `created_by_email?: string` The email of the user who created this workspace - `deleted_at?: string` Deleted date - `description?: string` Description of the workspace - `evaluation_test_cases?: Array` Evaluations - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` - `name?: string` Name of the workspace - `updated_at?: string` Update date - `uuid?: string` Unique id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const workspace = await client.agents.evaluationMetrics.workspaces.retrieve( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(workspace.workspace); ``` ## Update `client.agents.evaluationMetrics.workspaces.update(stringworkspaceUuid, WorkspaceUpdateParamsbody?, RequestOptionsoptions?): WorkspaceUpdateResponse` **put** `/v2/gen-ai/workspaces/{workspace_uuid}` To update a workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}`. The response body is a JSON object containing the workspace. ### Parameters - `workspaceUuid: string` - `body: WorkspaceUpdateParams` - `description?: string` The new description of the workspace - `name?: string` The new name of the workspace - `workspace_uuid?: string` Workspace UUID. ### Returns - `WorkspaceUpdateResponse` - `workspace?: APIWorkspace` - `agents?: Array` Agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `created_at?: string` Creation date - `created_by?: string` The id of user who created this workspace - `created_by_email?: string` The email of the user who created this workspace - `deleted_at?: string` Deleted date - `description?: string` Description of the workspace - `evaluation_test_cases?: Array` Evaluations - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` - `name?: string` Name of the workspace - `updated_at?: string` Update date - `uuid?: string` Unique id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const workspace = await client.agents.evaluationMetrics.workspaces.update( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(workspace.workspace); ``` ## List `client.agents.evaluationMetrics.workspaces.list(RequestOptionsoptions?): WorkspaceListResponse` **get** `/v2/gen-ai/workspaces` To list all workspaces, send a GET request to `/v2/gen-ai/workspaces`. ### Returns - `WorkspaceListResponse` - `workspaces?: Array` Workspaces - `agents?: Array` Agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `created_at?: string` Creation date - `created_by?: string` The id of user who created this workspace - `created_by_email?: string` The email of the user who created this workspace - `deleted_at?: string` Deleted date - `description?: string` Description of the workspace - `evaluation_test_cases?: Array` Evaluations - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` - `name?: string` Name of the workspace - `updated_at?: string` Update date - `uuid?: string` Unique id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const workspaces = await client.agents.evaluationMetrics.workspaces.list(); console.log(workspaces.workspaces); ``` ## Delete `client.agents.evaluationMetrics.workspaces.delete(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceDeleteResponse` **delete** `/v2/gen-ai/workspaces/{workspace_uuid}` To delete a workspace, send a DELETE request to `/v2/gen-ai/workspace/{workspace_uuid}`. ### Parameters - `workspaceUuid: string` ### Returns - `WorkspaceDeleteResponse` - `workspace_uuid?: string` Workspace ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const workspace = await client.agents.evaluationMetrics.workspaces.delete( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(workspace.workspace_uuid); ``` ## List Evaluation Test Cases `client.agents.evaluationMetrics.workspaces.listEvaluationTestCases(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceListEvaluationTestCasesResponse` **get** `/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases` To list all evaluation test cases by a workspace, send a GET request to `/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases`. ### Parameters - `workspaceUuid: string` ### Returns - `WorkspaceListEvaluationTestCasesResponse` - `evaluation_test_cases?: Array` - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.workspaces.listEvaluationTestCases( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(response.evaluation_test_cases); ``` # Agents ## List `client.agents.evaluationMetrics.workspaces.agents.list(stringworkspaceUuid, AgentListParamsquery?, RequestOptionsoptions?): AgentListResponse` **get** `/v2/gen-ai/workspaces/{workspace_uuid}/agents` To list all agents by a Workspace, send a GET request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. ### Parameters - `workspaceUuid: string` - `query: AgentListParams` - `only_deployed?: boolean` Only list agents that are deployed. - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `AgentListResponse` - `agents?: Array` - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const agents = await client.agents.evaluationMetrics.workspaces.agents.list( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(agents.agents); ``` ## Move `client.agents.evaluationMetrics.workspaces.agents.move(stringworkspaceUuid, AgentMoveParamsbody?, RequestOptionsoptions?): AgentMoveResponse` **put** `/v2/gen-ai/workspaces/{workspace_uuid}/agents` To move all listed agents a given workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. ### Parameters - `workspaceUuid: string` - `body: AgentMoveParams` - `agent_uuids?: Array` Agent uuids - `workspace_uuid?: string` Workspace uuid to move agents to ### Returns - `AgentMoveResponse` - `workspace?: APIWorkspace` - `agents?: Array` Agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `created_at?: string` Creation date - `created_by?: string` The id of user who created this workspace - `created_by_email?: string` The email of the user who created this workspace - `deleted_at?: string` Deleted date - `description?: string` Description of the workspace - `evaluation_test_cases?: Array` Evaluations - `archived_at?: string` - `created_at?: string` - `created_by_user_email?: string` - `created_by_user_id?: string` - `dataset?: Dataset` - `created_at?: string` Time created at. - `dataset_name?: string` Name of the dataset. - `dataset_uuid?: string` UUID of the dataset. - `file_size?: string` The size of the dataset uploaded file in bytes. - `has_ground_truth?: boolean` Does the dataset have a ground truth column? - `row_count?: number` Number of rows in the dataset. - `dataset_name?: string` - `dataset_uuid?: string` - `description?: string` - `latest_version_number_of_runs?: number` - `metrics?: Array` - `description?: string` - `inverted?: boolean` If true, the metric is inverted, meaning that a lower value is better. - `metric_name?: string` - `metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"` - `"METRIC_TYPE_UNSPECIFIED"` - `"METRIC_TYPE_GENERAL_QUALITY"` - `"METRIC_TYPE_RAG_AND_TOOL"` - `metric_uuid?: string` - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `range_max?: number` The maximum value for the metric. - `range_min?: number` The minimum value for the metric. - `name?: string` - `star_metric?: APIStarMetric` - `metric_uuid?: string` - `name?: string` - `success_threshold?: number` The success threshold for the star metric. This is a value that the metric must reach to be considered successful. - `success_threshold_pct?: number` The success threshold for the star metric. This is a percentage value between 0 and 100. - `test_case_uuid?: string` - `total_runs?: number` - `updated_at?: string` - `updated_by_user_email?: string` - `updated_by_user_id?: string` - `version?: number` - `name?: string` Name of the workspace - `updated_at?: string` Update date - `uuid?: string` Unique id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.workspaces.agents.move( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(response.workspace); ``` # Models ## List `client.agents.evaluationMetrics.models.list(ModelListParamsquery?, RequestOptionsoptions?): ModelListResponse` **get** `/v2/gen-ai/models` To list all models, send a GET request to `/v2/gen-ai/models`. ### Parameters - `query: ModelListParams` - `page?: number` Page number. - `per_page?: number` Items per page. - `public_only?: boolean` Only include models that are publicly available. - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Include only models defined for the listed usecases. - MODEL_USECASE_UNKNOWN: The use case of the model is unknown - MODEL_USECASE_AGENT: The model maybe used in an agent - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails - MODEL_USECASE_REASONING: The model usecase for reasoning - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` ### Returns - `ModelListResponse` A list of models - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages - `models?: Array` The models - `id?: string` Human-readable model identifier - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `is_foundational?: boolean` True if it is a foundational model provided by do - `name?: string` Display name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const models = await client.agents.evaluationMetrics.models.list(); console.log(models.links); ``` # Anthropic # Keys ## Create `client.agents.evaluationMetrics.anthropic.keys.create(KeyCreateParamsbody?, RequestOptionsoptions?): KeyCreateResponse` **post** `/v2/gen-ai/anthropic/keys` To create an Anthropic API key, send a POST request to `/v2/gen-ai/anthropic/keys`. ### Parameters - `body: KeyCreateParams` - `api_key?: string` Anthropic API key - `name?: string` Name of the key ### Returns - `KeyCreateResponse` CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic API key. - `api_key_info?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.anthropic.keys.create(); console.log(key.api_key_info); ``` ## Retrieve `client.agents.evaluationMetrics.anthropic.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse` **get** `/v2/gen-ai/anthropic/keys/{api_key_uuid}` To retrieve details of an Anthropic API key, send a GET request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` ### Returns - `KeyRetrieveResponse` - `api_key_info?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.anthropic.keys.retrieve( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## Update `client.agents.evaluationMetrics.anthropic.keys.update(stringapiKeyUuid, KeyUpdateParamsbody?, RequestOptionsoptions?): KeyUpdateResponse` **put** `/v2/gen-ai/anthropic/keys/{api_key_uuid}` To update an Anthropic API key, send a PUT request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` - `body: KeyUpdateParams` - `api_key?: string` Anthropic API key - `api_key_uuid?: string` API key ID - `name?: string` Name of the key ### Returns - `KeyUpdateResponse` UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic API key. - `api_key_info?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.anthropic.keys.update( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## List `client.agents.evaluationMetrics.anthropic.keys.list(KeyListParamsquery?, RequestOptionsoptions?): KeyListResponse` **get** `/v2/gen-ai/anthropic/keys` To list all Anthropic API keys, send a GET request to `/v2/gen-ai/anthropic/keys`. ### Parameters - `query: KeyListParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `KeyListResponse` ListAnthropicAPIKeysOutput is used to return the list of Anthropic API keys for a specific agent. - `api_key_infos?: Array` Api key infos - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const keys = await client.agents.evaluationMetrics.anthropic.keys.list(); console.log(keys.api_key_infos); ``` ## Delete `client.agents.evaluationMetrics.anthropic.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse` **delete** `/v2/gen-ai/anthropic/keys/{api_key_uuid}` To delete an Anthropic API key, send a DELETE request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` ### Returns - `KeyDeleteResponse` DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic API key. - `api_key_info?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.anthropic.keys.delete( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## List Agents `client.agents.evaluationMetrics.anthropic.keys.listAgents(stringuuid, KeyListAgentsParamsquery?, RequestOptionsoptions?): KeyListAgentsResponse` **get** `/v2/gen-ai/anthropic/keys/{uuid}/agents` List Agents by Anthropic Key. ### Parameters - `uuid: string` - `query: KeyListAgentsParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `KeyListAgentsResponse` List of Agents that linked to a specific Anthropic Key - `agents?: Array` - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.anthropic.keys.listAgents( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(response.agents); ``` # OpenAI # Keys ## Create `client.agents.evaluationMetrics.openai.keys.create(KeyCreateParamsbody?, RequestOptionsoptions?): KeyCreateResponse` **post** `/v2/gen-ai/openai/keys` To create an OpenAI API key, send a POST request to `/v2/gen-ai/openai/keys`. ### Parameters - `body: KeyCreateParams` - `api_key?: string` OpenAI API key - `name?: string` Name of the key ### Returns - `KeyCreateResponse` CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key. - `api_key_info?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.openai.keys.create(); console.log(key.api_key_info); ``` ## Retrieve `client.agents.evaluationMetrics.openai.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse` **get** `/v2/gen-ai/openai/keys/{api_key_uuid}` To retrieve details of an OpenAI API key, send a GET request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` ### Returns - `KeyRetrieveResponse` - `api_key_info?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.openai.keys.retrieve( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## Update `client.agents.evaluationMetrics.openai.keys.update(stringapiKeyUuid, KeyUpdateParamsbody?, RequestOptionsoptions?): KeyUpdateResponse` **put** `/v2/gen-ai/openai/keys/{api_key_uuid}` To update an OpenAI API key, send a PUT request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` - `body: KeyUpdateParams` - `api_key?: string` OpenAI API key - `api_key_uuid?: string` API key ID - `name?: string` Name of the key ### Returns - `KeyUpdateResponse` UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key. - `api_key_info?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.openai.keys.update( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## List `client.agents.evaluationMetrics.openai.keys.list(KeyListParamsquery?, RequestOptionsoptions?): KeyListResponse` **get** `/v2/gen-ai/openai/keys` To list all OpenAI API keys, send a GET request to `/v2/gen-ai/openai/keys`. ### Parameters - `query: KeyListParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `KeyListResponse` ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys for a specific agent. - `api_key_infos?: Array` Api key infos - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const keys = await client.agents.evaluationMetrics.openai.keys.list(); console.log(keys.api_key_infos); ``` ## Delete `client.agents.evaluationMetrics.openai.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse` **delete** `/v2/gen-ai/openai/keys/{api_key_uuid}` To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` ### Returns - `KeyDeleteResponse` DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key. - `api_key_info?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const key = await client.agents.evaluationMetrics.openai.keys.delete( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(key.api_key_info); ``` ## List Agents `client.agents.evaluationMetrics.openai.keys.listAgents(stringuuid, KeyListAgentsParamsquery?, RequestOptionsoptions?): KeyListAgentsResponse` **get** `/v2/gen-ai/openai/keys/{uuid}/agents` List Agents by OpenAI Key. ### Parameters - `uuid: string` - `query: KeyListAgentsParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `KeyListAgentsResponse` List of Agents that are linked to a specific OpenAI Key - `agents?: Array` - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `APIAgent` An Agent - `anthropic_api_key?: APIAnthropicAPIKeyInfo` Anthropic API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `api_key_infos?: Array` Api key infos - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid - `api_keys?: Array` Api keys - `api_key?: string` Api key - `chatbot?: Chatbot` A Chatbot - `button_background_color?: string` - `logo?: string` - `name?: string` Name of chatbot - `primary_color?: string` - `secondary_color?: string` - `starting_message?: string` - `chatbot_identifiers?: Array` Chatbot identifiers - `agent_chatbot_identifier?: string` Agent chatbot identifier - `child_agents?: Array` Child agents - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `conversation_logs_enabled?: boolean` Whether conversation logs are enabled for the agent - `created_at?: string` Creation date / time - `deployment?: Deployment` Description of deployment - `created_at?: string` Creation date / time - `name?: string` Name - `status?: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | 6 more` - `"STATUS_UNKNOWN"` - `"STATUS_WAITING_FOR_DEPLOYMENT"` - `"STATUS_DEPLOYING"` - `"STATUS_RUNNING"` - `"STATUS_FAILED"` - `"STATUS_WAITING_FOR_UNDEPLOYMENT"` - `"STATUS_UNDEPLOYING"` - `"STATUS_UNDEPLOYMENT_FAILED"` - `"STATUS_DELETED"` - `updated_at?: string` Last modified - `url?: string` Access your deployed agent here - `uuid?: string` Unique id - `visibility?: APIDeploymentVisibility` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` - `description?: string` Description of agent - `functions?: Array` - `api_key?: string` Api key - `created_at?: string` Creation date / time - `created_by?: string` Created by user id from DO - `description?: string` Agent description - `faas_name?: string` - `faas_namespace?: string` - `input_schema?: unknown` - `name?: string` Name - `output_schema?: unknown` - `updated_at?: string` Last modified - `url?: string` Download your agent here - `uuid?: string` Unique id - `guardrails?: Array` The guardrails the agent is attached to - `agent_uuid?: string` - `created_at?: string` - `default_response?: string` - `description?: string` - `guardrail_uuid?: string` - `is_attached?: boolean` - `is_default?: boolean` - `metadata?: unknown` - `name?: string` - `priority?: number` - `type?: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"` - `"GUARDRAIL_TYPE_UNKNOWN"` - `"GUARDRAIL_TYPE_JAILBREAK"` - `"GUARDRAIL_TYPE_SENSITIVE_DATA"` - `"GUARDRAIL_TYPE_CONTENT_MODERATION"` - `updated_at?: string` - `uuid?: string` - `if_case?: string` - `instruction?: string` Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - `k?: number` - `knowledge_bases?: Array` Knowledge bases - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `logging_config?: LoggingConfig` - `galileo_project_id?: string` Galileo project identifier - `galileo_project_name?: string` Name of the Galileo project - `insights_enabled?: boolean` Whether insights are enabled - `insights_enabled_at?: string` Timestamp when insights were enabled - `log_stream_id?: string` Identifier for the log stream - `log_stream_name?: string` Name of the log stream - `max_tokens?: number` - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Agent name - `openai_api_key?: APIOpenAIAPIKeyInfo` OpenAI API Key Info - `created_at?: string` Key creation date - `created_by?: string` Created by user id from DO - `deleted_at?: string` Key deleted date - `models?: Array` Models supported by the openAI api key - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name - `updated_at?: string` Key last updated date - `uuid?: string` Uuid - `parent_agents?: Array` Parent agents - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `project_id?: string` - `provide_citations?: boolean` Whether the agent should provide in-response citations - `region?: string` Region code - `retrieval_method?: APIRetrievalMethod` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` - `route_created_at?: string` Creation of route date / time - `route_created_by?: string` - `route_name?: string` Route name - `route_uuid?: string` - `tags?: Array` Agent tag to organize related resources - `temperature?: number` - `template?: Template` Represents an AgentTemplate entity - `created_at?: string` The agent template's creation date - `description?: string` Deprecated - Use summary instead - `guardrails?: Array` List of guardrails associated with the agent template - `priority?: number` Priority of the guardrail - `uuid?: string` Uuid of the guardrail - `instruction?: string` Instructions for the agent template - `k?: number` The 'k' value for the agent template - `knowledge_bases?: Array` List of knowledge bases associated with the agent template - `added_to_agent_at?: string` Time when the knowledge base was added to the agent - `created_at?: string` Creation date / time - `database_id?: string` - `embedding_model_uuid?: string` - `is_public?: boolean` Whether the knowledge base is public or not - `last_indexing_job?: APIIndexingJob` IndexingJob description - `completed_datasources?: number` Number of datasources indexed completed - `created_at?: string` Creation date / time - `data_source_uuids?: Array` - `finished_at?: string` - `knowledge_base_uuid?: string` Knowledge base id - `phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more` - `"BATCH_JOB_PHASE_UNKNOWN"` - `"BATCH_JOB_PHASE_PENDING"` - `"BATCH_JOB_PHASE_RUNNING"` - `"BATCH_JOB_PHASE_SUCCEEDED"` - `"BATCH_JOB_PHASE_FAILED"` - `"BATCH_JOB_PHASE_ERROR"` - `"BATCH_JOB_PHASE_CANCELLED"` - `started_at?: string` - `status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more` - `"INDEX_JOB_STATUS_UNKNOWN"` - `"INDEX_JOB_STATUS_PARTIAL"` - `"INDEX_JOB_STATUS_IN_PROGRESS"` - `"INDEX_JOB_STATUS_COMPLETED"` - `"INDEX_JOB_STATUS_FAILED"` - `"INDEX_JOB_STATUS_NO_CHANGES"` - `"INDEX_JOB_STATUS_PENDING"` - `tokens?: number` Number of tokens - `total_datasources?: number` Number of datasources being indexed - `total_items_failed?: string` Total Items Failed - `total_items_indexed?: string` Total Items Indexed - `total_items_skipped?: string` Total Items Skipped - `updated_at?: string` Last modified - `uuid?: string` Unique id - `name?: string` Name of knowledge base - `project_id?: string` - `region?: string` Region code - `tags?: Array` Tags to organize related resources - `updated_at?: string` Last modified - `user_id?: string` Id of user that created the knowledge base - `uuid?: string` Unique id for knowledge base - `long_description?: string` The long description of the agent template - `max_tokens?: number` The max_tokens setting for the agent template - `model?: APIAgentModel` Description of a Model - `agreement?: APIAgreement` Agreement Description - `description?: string` - `name?: string` - `url?: string` - `uuid?: string` - `created_at?: string` Creation date / time - `inference_name?: string` Internally used name - `inference_version?: string` Internally used version - `is_foundational?: boolean` True if it is a foundational model provided by do - `metadata?: unknown` Additional meta data - `name?: string` Name of the model - `parent_uuid?: string` Unique id of the model, this model is based on - `provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"` - `"MODEL_PROVIDER_DIGITALOCEAN"` - `"MODEL_PROVIDER_ANTHROPIC"` - `"MODEL_PROVIDER_OPENAI"` - `updated_at?: string` Last modified - `upload_complete?: boolean` Model has been fully uploaded - `url?: string` Download url - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>` Usecases of the model - `"MODEL_USECASE_UNKNOWN"` - `"MODEL_USECASE_AGENT"` - `"MODEL_USECASE_FINETUNED"` - `"MODEL_USECASE_KNOWLEDGEBASE"` - `"MODEL_USECASE_GUARDRAIL"` - `"MODEL_USECASE_REASONING"` - `"MODEL_USECASE_SERVERLESS"` - `uuid?: string` Unique id - `version?: APIModelVersion` Version Information about a Model - `major?: number` Major version number - `minor?: number` Minor version number - `patch?: number` Patch version number - `name?: string` Name of the agent template - `short_description?: string` The short description of the agent template - `summary?: string` The summary of the agent template - `tags?: Array` List of tags associated with the agent template - `temperature?: number` The temperature setting for the agent template - `template_type?: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"` - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template - `"AGENT_TEMPLATE_TYPE_STANDARD"` - `"AGENT_TEMPLATE_TYPE_ONE_CLICK"` - `top_p?: number` The top_p setting for the agent template - `updated_at?: string` The agent template's last updated date - `uuid?: string` Unique id - `top_p?: number` - `updated_at?: string` Last modified - `url?: string` Access your agent under this url - `user_id?: string` Id of user that created the agent - `uuid?: string` Unique agent id - `version_hash?: string` The latest version of the agent - `workspace?: APIWorkspace` - `links?: APILinks` Links to other pages - `pages?: Pages` Information about how to reach other pages - `first?: string` First page - `last?: string` Last page - `next?: string` Next page - `previous?: string` Previous page - `meta?: APIMeta` Meta information about the data set - `page?: number` The current page - `pages?: number` Total number of pages - `total?: number` Total amount of items over all pages ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.openai.keys.listAgents( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(response.agents); ``` # Oauth2 ## Generate URL `client.agents.evaluationMetrics.oauth2.generateURL(Oauth2GenerateURLParamsquery?, RequestOptionsoptions?): Oauth2GenerateURLResponse` **get** `/v2/gen-ai/oauth2/url` To generate an Oauth2-URL for use with your localhost, send a GET request to `/v2/gen-ai/oauth2/url`. Pass 'http://localhost:3000 as redirect_url ### Parameters - `query: Oauth2GenerateURLParams` - `redirect_url?: string` The redirect url. - `type?: string` Type "google" / "dropbox". ### Returns - `Oauth2GenerateURLResponse` The url for the oauth2 flow - `url?: string` The oauth2 url ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.oauth2.generateURL(); console.log(response.url); ``` # Dropbox ## Create Tokens `client.agents.evaluationMetrics.oauth2.dropbox.createTokens(DropboxCreateTokensParamsbody?, RequestOptionsoptions?): DropboxCreateTokensResponse` **post** `/v2/gen-ai/oauth2/dropbox/tokens` To obtain the refresh token, needed for creation of data sources, send a GET request to `/v2/gen-ai/oauth2/dropbox/tokens`. Pass the code you obtrained from the oauth flow in the field 'code' ### Parameters - `body: DropboxCreateTokensParams` - `code?: string` The oauth2 code from google - `redirect_url?: string` Redirect url ### Returns - `DropboxCreateTokensResponse` The dropbox oauth2 token and refresh token - `token?: string` The access token - `refresh_token?: string` The refresh token ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationMetrics.oauth2.dropbox.createTokens(); console.log(response.token); ```