# Agents ## Create `client.agents.create(AgentCreateParamsbody?, RequestOptionsoptions?): AgentCreateResponse` **post** `/v2/gen-ai/agents` To create a new agent, send a POST request to `/v2/gen-ai/agents`. The response body contains a JSON object with the newly created agent object. ### Parameters - `body: AgentCreateParams` - `anthropic_key_uuid?: string` Optional Anthropic API key ID to use with Anthropic models - `description?: string` A text description of the agent, not used in inference - `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. - `knowledge_base_uuid?: Array` Ids of the knowledge base(s) to attach to the agent - `model_uuid?: string` Identifier for the foundation model. - `name?: string` Agent name - `open_ai_key_uuid?: string` Optional OpenAI API key ID to use with OpenAI models - `project_id?: string` The id of the DigitalOcean project this agent will belong to - `region?: string` The DigitalOcean region to deploy your agent in - `tags?: Array` Agent tag to organize related resources ### Returns - `AgentCreateResponse` Information about a newly created Agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const agent = await client.agents.create(); console.log(agent.agent); ``` ## Retrieve `client.agents.retrieve(stringuuid, RequestOptionsoptions?): AgentRetrieveResponse` **get** `/v2/gen-ai/agents/{uuid}` To retrieve details of an agent, GET request to `/v2/gen-ai/agents/{uuid}`. The response body is a JSON object containing the agent. ### Parameters - `uuid: string` ### Returns - `AgentRetrieveResponse` One Agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const agent = await client.agents.retrieve('"123e4567-e89b-12d3-a456-426614174000"'); console.log(agent.agent); ``` ## Update `client.agents.update(stringpathUuid, AgentUpdateParamsbody?, RequestOptionsoptions?): AgentUpdateResponse` **put** `/v2/gen-ai/agents/{uuid}` To update an agent, send a PUT request to `/v2/gen-ai/agents/{uuid}`. The response body is a JSON object containing the agent. ### Parameters - `pathUuid: string` - `body: AgentUpdateParams` - `agent_log_insights_enabled?: boolean` - `anthropic_key_uuid?: string` Optional anthropic key uuid for use with anthropic models - `conversation_logs_enabled?: boolean` Optional update of conversation logs enabled - `description?: string` Agent description - `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` How many results should be considered from an attached knowledge base - `max_tokens?: number` Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. - `model_uuid?: string` Identifier for the foundation model. - `name?: string` Agent name - `open_ai_key_uuid?: string` Optional OpenAI key uuid for use with OpenAI models - `project_id?: string` The id of the DigitalOcean project this agent will belong to - `provide_citations?: boolean` - `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"` - `tags?: Array` A set of abitrary tags to organize your agent - `temperature?: number` Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. - `top_p?: number` Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. - `body_uuid?: string` Unique agent id ### Returns - `AgentUpdateResponse` Information about an updated agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const agent = await client.agents.update('"123e4567-e89b-12d3-a456-426614174000"'); console.log(agent.agent); ``` ## List `client.agents.list(AgentListParamsquery?, RequestOptionsoptions?): AgentListResponse` **get** `/v2/gen-ai/agents` To list all agents, send a GET request to `/v2/gen-ai/agents`. ### Parameters - `query: AgentListParams` - `only_deployed?: boolean` Only list agents that are deployed. - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `AgentListResponse` List of Agents - `agents?: Array` Agents - `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 - `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 - `if_case?: string` Instructions to the agent on how to use the route - `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` How many results should be considered from an attached knowledge base - `max_tokens?: number` Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. - `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 - `project_id?: string` The DigitalOcean project ID associated with the agent - `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` Id of user that created the route - `route_name?: string` Route name - `route_uuid?: string` Route uuid - `tags?: Array` A set of abitrary tags to organize your agent - `temperature?: number` Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. - `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` Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. - `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 - `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.list(); console.log(agents.agents); ``` ## Delete `client.agents.delete(stringuuid, RequestOptionsoptions?): AgentDeleteResponse` **delete** `/v2/gen-ai/agents/{uuid}` To delete an agent, send a DELETE request to `/v2/gen-ai/agents/{uuid}`. ### Parameters - `uuid: string` ### Returns - `AgentDeleteResponse` Info about a deleted agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const agent = await client.agents.delete('"123e4567-e89b-12d3-a456-426614174000"'); console.log(agent.agent); ``` ## Retrieve Usage `client.agents.retrieveUsage(stringuuid, AgentRetrieveUsageParamsquery?, RequestOptionsoptions?): AgentRetrieveUsageResponse` **get** `/v2/gen-ai/agents/{uuid}/usage` To get agent usage, send a GET request to `/v2/gen-ai/agents/{uuid}/usage`. Returns usage metrics for the specified agent within the provided time range. ### Parameters - `uuid: string` - `query: AgentRetrieveUsageParams` - `start?: string` Return all usage data from this date. - `stop?: string` Return all usage data up to this date, if omitted, will return up to the current date. ### Returns - `AgentRetrieveUsageResponse` Agent usage - `log_insights_usage?: LogInsightsUsage` Resource Usage Description - `measurements?: Array` - `tokens?: number` - `usage_type?: string` - `resource_uuid?: string` - `start?: string` - `stop?: string` - `usage?: Usage` Resource Usage Description - `measurements?: Array` - `tokens?: number` - `usage_type?: string` - `resource_uuid?: string` - `start?: string` - `stop?: string` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.retrieveUsage('"123e4567-e89b-12d3-a456-426614174000"'); console.log(response.log_insights_usage); ``` ## Update Status `client.agents.updateStatus(stringpathUuid, AgentUpdateStatusParamsbody?, RequestOptionsoptions?): AgentUpdateStatusResponse` **put** `/v2/gen-ai/agents/{uuid}/deployment_visibility` Check whether an agent is public or private. To update the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. ### Parameters - `pathUuid: string` - `body: AgentUpdateStatusParams` - `body_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"` ### Returns - `AgentUpdateStatusResponse` UpdateAgentDeploymentVisbilityOutput description - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.updateStatus('"123e4567-e89b-12d3-a456-426614174000"'); console.log(response.agent); ``` ## Domain Types ### API Agent - `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` ### API Agent API Key Info - `APIAgentAPIKeyInfo` Agent API Key Info - `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 Agent 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 ### API Anthropic 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 ### API Deployment Visibility - `APIDeploymentVisibility = "VISIBILITY_UNKNOWN" | "VISIBILITY_DISABLED" | "VISIBILITY_PLAYGROUND" | 2 more` - VISIBILITY_UNKNOWN: The status of the deployment is unknown - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys - `"VISIBILITY_UNKNOWN"` - `"VISIBILITY_DISABLED"` - `"VISIBILITY_PLAYGROUND"` - `"VISIBILITY_PUBLIC"` - `"VISIBILITY_PRIVATE"` ### API OpenAI 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 ### API Retrieval Method - `APIRetrievalMethod = "RETRIEVAL_METHOD_UNKNOWN" | "RETRIEVAL_METHOD_REWRITE" | "RETRIEVAL_METHOD_STEP_BACK" | 2 more` - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none - `"RETRIEVAL_METHOD_UNKNOWN"` - `"RETRIEVAL_METHOD_REWRITE"` - `"RETRIEVAL_METHOD_STEP_BACK"` - `"RETRIEVAL_METHOD_SUB_QUERIES"` - `"RETRIEVAL_METHOD_NONE"` ### API 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 # API Keys ## Create `client.agents.apiKeys.create(stringagentUuid, APIKeyCreateParamsbody?, RequestOptionsoptions?): APIKeyCreateResponse` **post** `/v2/gen-ai/agents/{agent_uuid}/api_keys` To create an agent API key, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. ### Parameters - `agentUuid: string` - `body: APIKeyCreateParams` - `agent_uuid?: string` Agent id - `name?: string` A human friendly name to identify the key ### Returns - `APIKeyCreateResponse` - `api_key_info?: APIAgentAPIKeyInfo` Agent API Key Info - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const apiKey = await client.agents.apiKeys.create('"123e4567-e89b-12d3-a456-426614174000"'); console.log(apiKey.api_key_info); ``` ## Update `client.agents.apiKeys.update(stringapiKeyUuid, APIKeyUpdateParamsparams, RequestOptionsoptions?): APIKeyUpdateResponse` **put** `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}` To update an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` - `params: APIKeyUpdateParams` - `body_agent_uuid?: string` Body param: Agent id - `api_key_uuid?: string` Body param: API key ID - `name?: string` Body param: Name ### Returns - `APIKeyUpdateResponse` - `api_key_info?: APIAgentAPIKeyInfo` Agent API Key Info - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const apiKey = await client.agents.apiKeys.update('"123e4567-e89b-12d3-a456-426614174000"', { path_agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(apiKey.api_key_info); ``` ## List `client.agents.apiKeys.list(stringagentUuid, APIKeyListParamsquery?, RequestOptionsoptions?): APIKeyListResponse` **get** `/v2/gen-ai/agents/{agent_uuid}/api_keys` To list all agent API keys, send a GET request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. ### Parameters - `agentUuid: string` - `query: APIKeyListParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `APIKeyListResponse` - `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 - `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 apiKeys = await client.agents.apiKeys.list('"123e4567-e89b-12d3-a456-426614174000"'); console.log(apiKeys.api_key_infos); ``` ## Delete `client.agents.apiKeys.delete(stringapiKeyUuid, APIKeyDeleteParamsparams, RequestOptionsoptions?): APIKeyDeleteResponse` **delete** `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}` To delete an API key for an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. ### Parameters - `apiKeyUuid: string` - `params: APIKeyDeleteParams` - `agent_uuid: string` A unique identifier for your agent. ### Returns - `APIKeyDeleteResponse` - `api_key_info?: APIAgentAPIKeyInfo` Agent API Key Info - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const apiKey = await client.agents.apiKeys.delete('"123e4567-e89b-12d3-a456-426614174000"', { agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(apiKey.api_key_info); ``` ## Regenerate `client.agents.apiKeys.regenerate(stringapiKeyUuid, APIKeyRegenerateParamsparams, RequestOptionsoptions?): APIKeyRegenerateResponse` **put** `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate` To regenerate an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate`. ### Parameters - `apiKeyUuid: string` - `params: APIKeyRegenerateParams` - `agent_uuid: string` Agent id ### Returns - `APIKeyRegenerateResponse` - `api_key_info?: APIAgentAPIKeyInfo` Agent API Key Info - `created_at?: string` Creation date - `created_by?: string` Created by - `deleted_at?: string` Deleted date - `name?: string` Name - `secret_key?: string` - `uuid?: string` Uuid ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.apiKeys.regenerate('"123e4567-e89b-12d3-a456-426614174000"', { agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(response.api_key_info); ``` # Chat # Completions ## Create `client.agents.chat.completions.create(CompletionCreateParamsbody, RequestOptionsoptions?): CompletionCreateResponse | Stream` **post** `/chat/completions?agent=true` Creates a model response for the given chat conversation. ### Parameters - `CompletionCreateParams = CompletionCreateParamsNonStreaming | CompletionCreateParamsStreaming` - `CompletionCreateParamsBase` - `messages: Array` A list of messages comprising the conversation so far. - `ChatCompletionRequestSystemMessage` System-provided instructions that the model should follow, regardless of messages sent by the user. - `content: string | Array` The contents of the system message. - `string` - `Array` - `string` - `UnionMember1` Content part with type and text - `text: string` The text content - `type: "text"` The type of content part - `"text"` - `role: "system"` The role of the messages author, in this case `system`. - `"system"` - `ChatCompletionRequestDeveloperMessage` Developer-provided instructions that the model should follow, regardless of messages sent by the user. - `content: string | Array` The contents of the developer message. - `string` - `Array` - `string` - `UnionMember1` Content part with type and text - `text: string` The text content - `type: "text"` The type of content part - `"text"` - `role: "developer"` The role of the messages author, in this case `developer`. - `"developer"` - `ChatCompletionRequestUserMessage` Messages sent by an end user, containing prompts or additional context information. - `content: string | Array` The contents of the user message. - `string` - `Array` - `string` - `UnionMember1` Content part with type and text - `text: string` The text content - `type: "text"` The type of content part - `"text"` - `role: "user"` The role of the messages author, in this case `user`. - `"user"` - `ChatCompletionRequestAssistantMessage` Messages sent by the model in response to user messages. - `role: "assistant"` The role of the messages author, in this case `assistant`. - `"assistant"` - `content?: string | Array | null` The contents of the assistant message. - `string` - `Array` - `string` - `UnionMember1` Content part with type and text - `text: string` The text content - `type: "text"` The type of content part - `"text"` - `tool_calls?: Array` The tool calls generated by the model, such as function calls. - `id: string` The ID of the tool call. - `function: Function` The function that the model called. - `arguments: string` The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. - `name: string` The name of the function to call. - `type: "function"` The type of the tool. Currently, only `function` is supported. - `"function"` - `ChatCompletionRequestToolMessage` - `content: string` The contents of the tool message. - `role: "tool"` The role of the messages author, in this case `tool`. - `"tool"` - `tool_call_id: string` Tool call that this message is responding to. - `model: string` Model ID used to generate the response. - `frequency_penalty?: number | null` Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. - `logit_bias?: Record | null` Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. - `logprobs?: boolean | null` Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. - `max_completion_tokens?: number | null` The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. - `max_tokens?: number | null` The maximum number of tokens that can be generated in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - `metadata?: Record | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `n?: number | null` How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. - `presence_penalty?: number | null` Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. - `stop?: string | null | Array` Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. - `string | null` - `Array` - `stream?: false | null` If set to true, the model response data will be streamed to the client as it is generated using server-sent events. - `false` - `stream_options?: StreamOptions | null` Options for streaming response. Only set this when you set `stream: true`. - `include_usage?: boolean` If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. **NOTE:** If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request. - `temperature?: number | null` What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. - `tool_choice?: "none" | "auto" | "required" | ChatCompletionNamedToolChoice` Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `ChatCompletionNamedToolChoice` Specifies a tool the model should use. Use to force the model to call a specific function. - `function: Function` - `name: string` The name of the function to call. - `type: "function"` The type of the tool. Currently, only `function` is supported. - `"function"` - `tools?: Array` A list of tools the model may call. Currently, only functions are supported as a tool. - `function: Function` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: Record` The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `type: "function"` The type of the tool. Currently, only `function` is supported. - `"function"` - `top_logprobs?: number | null` An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. - `top_p?: number | null` An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - `user?: string` A unique identifier representing your end-user, which can help DigitalOcean to monitor and detect abuse. - `CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase` - `stream?: false | null` If set to true, the model response data will be streamed to the client as it is generated using server-sent events. - `false` - `CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase` - `stream?: false | null` If set to true, the model response data will be streamed to the client as it is generated using server-sent events. - `false` ### Returns - `CompletionCreateResponse` Represents a chat completion response returned by model, based on the provided input. - `id: string` A unique identifier for the chat completion. - `choices: Array` A list of chat completion choices. Can be more than one if `n` is greater than 1. - `finish_reason: "stop" | "length" | "tool_calls" | "content_filter"` The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, or `length` if the maximum number of tokens specified in the request was reached, `tool_calls` if the model called a tool. - `"stop"` - `"length"` - `"tool_calls"` - `"content_filter"` - `index: number` The index of the choice in the list of choices. - `logprobs: Logprobs | null` Log probability information for the choice. - `content: Array | null` A list of message content tokens with log probability information. - `token: string` The token. - `bytes: Array | null` A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. - `logprob: number` The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. - `top_logprobs: Array` List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. - `token: string` The token. - `bytes: Array | null` A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. - `logprob: number` The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. - `refusal: Array | null` A list of message refusal tokens with log probability information. - `token: string` The token. - `bytes: Array | null` A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. - `logprob: number` The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. - `top_logprobs: Array` List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. - `token: string` The token. - `bytes: Array | null` A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. - `logprob: number` The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. - `message: Message` A chat completion message generated by the model. - `content: string | null` The contents of the message. - `reasoning_content: string | null` The reasoning content generated by the model. - `refusal: string | null` The refusal message generated by the model. - `role: "assistant"` The role of the author of this message. - `"assistant"` - `tool_calls?: Array` The tool calls generated by the model, such as function calls. - `id: string` The ID of the tool call. - `function: Function` The function that the model called. - `arguments: string` The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. - `name: string` The name of the function to call. - `type: "function"` The type of the tool. Currently, only `function` is supported. - `"function"` - `created: number` The Unix timestamp (in seconds) of when the chat completion was created. - `model: string` The model used for the chat completion. - `object: "chat.completion"` The object type, which is always `chat.completion`. - `"chat.completion"` - `usage?: CompletionUsage` Usage statistics for the completion request. - `completion_tokens: number` Number of tokens in the generated completion. - `prompt_tokens: number` Number of tokens in the prompt. - `total_tokens: number` Total number of tokens used in the request (prompt + completion). ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient({ accessToken: 'My Access Token', }); const completion = await client.agents.chat.completions.create({ messages: [{ content: 'string', role: 'system' }], model: 'llama3-8b-instruct', }); console.log(completion.id); ``` # 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); ``` # Evaluation Runs ## Create `client.agents.evaluationRuns.create(EvaluationRunCreateParamsbody?, RequestOptionsoptions?): EvaluationRunCreateResponse` **post** `/v2/gen-ai/evaluation_runs` To run an evaluation test case, send a POST request to `/v2/gen-ai/evaluation_runs`. ### Parameters - `body: EvaluationRunCreateParams` - `agent_uuids?: Array` Agent UUIDs to run the test case against. - `run_name?: string` The name of the run. - `test_case_uuid?: string` Test-case UUID to run ### Returns - `EvaluationRunCreateResponse` - `evaluation_run_uuids?: Array` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationRun = await client.agents.evaluationRuns.create(); console.log(evaluationRun.evaluation_run_uuids); ``` ## Retrieve `client.agents.evaluationRuns.retrieve(stringevaluationRunUuid, RequestOptionsoptions?): EvaluationRunRetrieveResponse` **get** `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}` To retrive information about an existing evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}`. ### Parameters - `evaluationRunUuid: string` ### Returns - `EvaluationRunRetrieveResponse` - `evaluation_run?: APIEvaluationRun` - `agent_deleted?: boolean` Whether agent is deleted - `agent_name?: string` Agent name - `agent_uuid?: string` Agent UUID. - `agent_version_hash?: string` Version hash - `agent_workspace_uuid?: string` Agent workspace uuid - `created_by_user_email?: string` - `created_by_user_id?: string` - `error_description?: string` The error description - `evaluation_run_uuid?: string` Evaluation run UUID. - `evaluation_test_case_workspace_uuid?: string` Evaluation test case workspace uuid - `finished_at?: string` Run end time. - `pass_status?: boolean` The pass status of the evaluation run based on the star metric. - `queued_at?: string` Run queued time. - `run_level_metric_results?: Array` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `run_name?: string` Run name. - `star_metric_result?: APIEvaluationMetricResult` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `started_at?: string` Run start time. - `status?: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | 6 more` Evaluation Run Statuses - `"EVALUATION_RUN_STATUS_UNSPECIFIED"` - `"EVALUATION_RUN_QUEUED"` - `"EVALUATION_RUN_RUNNING_DATASET"` - `"EVALUATION_RUN_EVALUATING_RESULTS"` - `"EVALUATION_RUN_CANCELLING"` - `"EVALUATION_RUN_CANCELLED"` - `"EVALUATION_RUN_SUCCESSFUL"` - `"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"` - `"EVALUATION_RUN_FAILED"` - `test_case_description?: string` Test case description. - `test_case_name?: string` Test case name. - `test_case_uuid?: string` Test-case UUID. - `test_case_version?: number` Test-case-version. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationRun = await client.agents.evaluationRuns.retrieve('"123e4567-e89b-12d3-a456-426614174000"'); console.log(evaluationRun.evaluation_run); ``` ## List Results `client.agents.evaluationRuns.listResults(stringevaluationRunUuid, EvaluationRunListResultsParamsquery?, RequestOptionsoptions?): EvaluationRunListResultsResponse` **get** `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results` To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results`. ### Parameters - `evaluationRunUuid: string` - `query: EvaluationRunListResultsParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `EvaluationRunListResultsResponse` Gets the full results of an evaluation run with all prompts. - `evaluation_run?: APIEvaluationRun` - `agent_deleted?: boolean` Whether agent is deleted - `agent_name?: string` Agent name - `agent_uuid?: string` Agent UUID. - `agent_version_hash?: string` Version hash - `agent_workspace_uuid?: string` Agent workspace uuid - `created_by_user_email?: string` - `created_by_user_id?: string` - `error_description?: string` The error description - `evaluation_run_uuid?: string` Evaluation run UUID. - `evaluation_test_case_workspace_uuid?: string` Evaluation test case workspace uuid - `finished_at?: string` Run end time. - `pass_status?: boolean` The pass status of the evaluation run based on the star metric. - `queued_at?: string` Run queued time. - `run_level_metric_results?: Array` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `run_name?: string` Run name. - `star_metric_result?: APIEvaluationMetricResult` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `started_at?: string` Run start time. - `status?: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | 6 more` Evaluation Run Statuses - `"EVALUATION_RUN_STATUS_UNSPECIFIED"` - `"EVALUATION_RUN_QUEUED"` - `"EVALUATION_RUN_RUNNING_DATASET"` - `"EVALUATION_RUN_EVALUATING_RESULTS"` - `"EVALUATION_RUN_CANCELLING"` - `"EVALUATION_RUN_CANCELLED"` - `"EVALUATION_RUN_SUCCESSFUL"` - `"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"` - `"EVALUATION_RUN_FAILED"` - `test_case_description?: string` Test case description. - `test_case_name?: string` Test case name. - `test_case_uuid?: string` Test-case UUID. - `test_case_version?: number` Test-case-version. - `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 - `prompts?: Array` The prompt level results. - `ground_truth?: string` The ground truth for the prompt. - `input?: string` - `input_tokens?: string` The number of input tokens used in the prompt. - `output?: string` - `output_tokens?: string` The number of output tokens used in the prompt. - `prompt_chunks?: Array` The list of prompt chunks. - `chunk_usage_pct?: number` The usage percentage of the chunk. - `chunk_used?: boolean` Indicates if the chunk was used in the prompt. - `index_uuid?: string` The index uuid (Knowledge Base) of the chunk. - `source_name?: string` The source name for the chunk, e.g., the file name or document title. - `text?: string` Text content of the chunk. - `prompt_id?: number` Prompt ID - `prompt_level_metric_results?: Array` The metric results for the prompt. - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationRuns.listResults('"123e4567-e89b-12d3-a456-426614174000"'); console.log(response.evaluation_run); ``` ## Retrieve Results `client.agents.evaluationRuns.retrieveResults(numberpromptID, EvaluationRunRetrieveResultsParamsparams, RequestOptionsoptions?): EvaluationRunRetrieveResultsResponse` **get** `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}` To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}`. ### Parameters - `promptID: number` - `params: EvaluationRunRetrieveResultsParams` - `evaluation_run_uuid: string` Evaluation run UUID. ### Returns - `EvaluationRunRetrieveResultsResponse` - `prompt?: APIEvaluationPrompt` - `ground_truth?: string` The ground truth for the prompt. - `input?: string` - `input_tokens?: string` The number of input tokens used in the prompt. - `output?: string` - `output_tokens?: string` The number of output tokens used in the prompt. - `prompt_chunks?: Array` The list of prompt chunks. - `chunk_usage_pct?: number` The usage percentage of the chunk. - `chunk_used?: boolean` Indicates if the chunk was used in the prompt. - `index_uuid?: string` The index uuid (Knowledge Base) of the chunk. - `source_name?: string` The source name for the chunk, e.g., the file name or document title. - `text?: string` Text content of the chunk. - `prompt_id?: number` Prompt ID - `prompt_level_metric_results?: Array` The metric results for the prompt. - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationRuns.retrieveResults(1, { evaluation_run_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(response.prompt); ``` ## Domain Types ### API Evaluation Metric - `APIEvaluationMetric` - `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. ### API Evaluation Metric Result - `APIEvaluationMetricResult` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. ### API Evaluation Prompt - `APIEvaluationPrompt` - `ground_truth?: string` The ground truth for the prompt. - `input?: string` - `input_tokens?: string` The number of input tokens used in the prompt. - `output?: string` - `output_tokens?: string` The number of output tokens used in the prompt. - `prompt_chunks?: Array` The list of prompt chunks. - `chunk_usage_pct?: number` The usage percentage of the chunk. - `chunk_used?: boolean` Indicates if the chunk was used in the prompt. - `index_uuid?: string` The index uuid (Knowledge Base) of the chunk. - `source_name?: string` The source name for the chunk, e.g., the file name or document title. - `text?: string` Text content of the chunk. - `prompt_id?: number` Prompt ID - `prompt_level_metric_results?: Array` The metric results for the prompt. - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. ### API Evaluation Run - `APIEvaluationRun` - `agent_deleted?: boolean` Whether agent is deleted - `agent_name?: string` Agent name - `agent_uuid?: string` Agent UUID. - `agent_version_hash?: string` Version hash - `agent_workspace_uuid?: string` Agent workspace uuid - `created_by_user_email?: string` - `created_by_user_id?: string` - `error_description?: string` The error description - `evaluation_run_uuid?: string` Evaluation run UUID. - `evaluation_test_case_workspace_uuid?: string` Evaluation test case workspace uuid - `finished_at?: string` Run end time. - `pass_status?: boolean` The pass status of the evaluation run based on the star metric. - `queued_at?: string` Run queued time. - `run_level_metric_results?: Array` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `run_name?: string` Run name. - `star_metric_result?: APIEvaluationMetricResult` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `started_at?: string` Run start time. - `status?: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | 6 more` Evaluation Run Statuses - `"EVALUATION_RUN_STATUS_UNSPECIFIED"` - `"EVALUATION_RUN_QUEUED"` - `"EVALUATION_RUN_RUNNING_DATASET"` - `"EVALUATION_RUN_EVALUATING_RESULTS"` - `"EVALUATION_RUN_CANCELLING"` - `"EVALUATION_RUN_CANCELLED"` - `"EVALUATION_RUN_SUCCESSFUL"` - `"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"` - `"EVALUATION_RUN_FAILED"` - `test_case_description?: string` Test case description. - `test_case_name?: string` Test case name. - `test_case_uuid?: string` Test-case UUID. - `test_case_version?: number` Test-case-version. # Evaluation Test Cases ## Create `client.agents.evaluationTestCases.create(EvaluationTestCaseCreateParamsbody?, RequestOptionsoptions?): EvaluationTestCaseCreateResponse` **post** `/v2/gen-ai/evaluation_test_cases` To create an evaluation test-case send a POST request to `/v2/gen-ai/evaluation_test_cases`. ### Parameters - `body: EvaluationTestCaseCreateParams` - `dataset_uuid?: string` Dataset against which the test‑case is executed. - `description?: string` Description of the test case. - `metrics?: Array` Full metric list to use for evaluation test case. - `name?: string` Name of the test case. - `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. - `workspace_uuid?: string` The workspace uuid. ### Returns - `EvaluationTestCaseCreateResponse` - `test_case_uuid?: string` Test‑case UUID. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationTestCase = await client.agents.evaluationTestCases.create(); console.log(evaluationTestCase.test_case_uuid); ``` ## Retrieve `client.agents.evaluationTestCases.retrieve(stringtestCaseUuid, EvaluationTestCaseRetrieveParamsquery?, RequestOptionsoptions?): EvaluationTestCaseRetrieveResponse` **get** `/v2/gen-ai/evaluation_test_cases/{test_case_uuid}` To retrive information about an existing evaluation test case, send a GET request to `/v2/gen-ai/evaluation_test_case/{test_case_uuid}`. ### Parameters - `testCaseUuid: string` - `query: EvaluationTestCaseRetrieveParams` - `evaluation_test_case_version?: number` Version of the test case. ### Returns - `EvaluationTestCaseRetrieveResponse` - `evaluation_test_case?: APIEvaluationTestCase` - `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 evaluationTestCase = await client.agents.evaluationTestCases.retrieve( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(evaluationTestCase.evaluation_test_case); ``` ## Update `client.agents.evaluationTestCases.update(stringtestCaseUuid, EvaluationTestCaseUpdateParamsbody?, RequestOptionsoptions?): EvaluationTestCaseUpdateResponse` **put** `/v2/gen-ai/evaluation_test_cases/{test_case_uuid}` To update an evaluation test-case send a PUT request to `/v2/gen-ai/evaluation_test_cases/{test_case_uuid}`. ### Parameters - `testCaseUuid: string` - `body: EvaluationTestCaseUpdateParams` - `dataset_uuid?: string` Dataset against which the test‑case is executed. - `description?: string` Description of the test case. - `metrics?: Metrics` - `metric_uuids?: Array` - `name?: string` Name of the test case. - `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` Test-case UUID to update ### Returns - `EvaluationTestCaseUpdateResponse` - `test_case_uuid?: string` - `version?: number` The new verson of the test case. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationTestCase = await client.agents.evaluationTestCases.update( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(evaluationTestCase.test_case_uuid); ``` ## List `client.agents.evaluationTestCases.list(RequestOptionsoptions?): EvaluationTestCaseListResponse` **get** `/v2/gen-ai/evaluation_test_cases` To list all evaluation test cases, send a GET request to `/v2/gen-ai/evaluation_test_cases`. ### Returns - `EvaluationTestCaseListResponse` - `evaluation_test_cases?: Array` Alternative way of authentication for internal usage only - should not be exposed to public api - `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 evaluationTestCases = await client.agents.evaluationTestCases.list(); console.log(evaluationTestCases.evaluation_test_cases); ``` ## List Evaluation Runs `client.agents.evaluationTestCases.listEvaluationRuns(stringevaluationTestCaseUuid, EvaluationTestCaseListEvaluationRunsParamsquery?, RequestOptionsoptions?): EvaluationTestCaseListEvaluationRunsResponse` **get** `/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs` To list all evaluation runs by test case, send a GET request to `/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs`. ### Parameters - `evaluationTestCaseUuid: string` - `query: EvaluationTestCaseListEvaluationRunsParams` - `evaluation_test_case_version?: number` Version of the test case. ### Returns - `EvaluationTestCaseListEvaluationRunsResponse` - `evaluation_runs?: Array` List of evaluation runs. - `agent_deleted?: boolean` Whether agent is deleted - `agent_name?: string` Agent name - `agent_uuid?: string` Agent UUID. - `agent_version_hash?: string` Version hash - `agent_workspace_uuid?: string` Agent workspace uuid - `created_by_user_email?: string` - `created_by_user_id?: string` - `error_description?: string` The error description - `evaluation_run_uuid?: string` Evaluation run UUID. - `evaluation_test_case_workspace_uuid?: string` Evaluation test case workspace uuid - `finished_at?: string` Run end time. - `pass_status?: boolean` The pass status of the evaluation run based on the star metric. - `queued_at?: string` Run queued time. - `run_level_metric_results?: Array` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `run_name?: string` Run name. - `star_metric_result?: APIEvaluationMetricResult` - `error_description?: string` Error description if the metric could not be calculated. - `metric_name?: string` Metric name - `metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"` - `"METRIC_VALUE_TYPE_UNSPECIFIED"` - `"METRIC_VALUE_TYPE_NUMBER"` - `"METRIC_VALUE_TYPE_STRING"` - `"METRIC_VALUE_TYPE_PERCENTAGE"` - `number_value?: number` The value of the metric as a number. - `reasoning?: string` Reasoning of the metric result. - `string_value?: string` The value of the metric as a string. - `started_at?: string` Run start time. - `status?: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | 6 more` Evaluation Run Statuses - `"EVALUATION_RUN_STATUS_UNSPECIFIED"` - `"EVALUATION_RUN_QUEUED"` - `"EVALUATION_RUN_RUNNING_DATASET"` - `"EVALUATION_RUN_EVALUATING_RESULTS"` - `"EVALUATION_RUN_CANCELLING"` - `"EVALUATION_RUN_CANCELLED"` - `"EVALUATION_RUN_SUCCESSFUL"` - `"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"` - `"EVALUATION_RUN_FAILED"` - `test_case_description?: string` Test case description. - `test_case_name?: string` Test case name. - `test_case_uuid?: string` Test-case UUID. - `test_case_version?: number` Test-case-version. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationTestCases.listEvaluationRuns( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(response.evaluation_runs); ``` ## Domain Types ### API Evaluation Test Case - `APIEvaluationTestCase` - `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` ### API 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. # Evaluation Datasets ## Create `client.agents.evaluationDatasets.create(EvaluationDatasetCreateParamsbody?, RequestOptionsoptions?): EvaluationDatasetCreateResponse` **post** `/v2/gen-ai/evaluation_datasets` To create an evaluation dataset, send a POST request to `/v2/gen-ai/evaluation_datasets`. ### Parameters - `body: EvaluationDatasetCreateParams` - `file_upload_dataset?: APIFileUploadDataSource` File to upload as data source for knowledge base. - `original_file_name?: string` The original file name - `size_in_bytes?: string` The size of the file in bytes - `stored_object_key?: string` The object key the file was stored as - `name?: string` The name of the agent evaluation dataset. ### Returns - `EvaluationDatasetCreateResponse` Output for creating an agent evaluation dataset - `evaluation_dataset_uuid?: string` Evaluation dataset uuid. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const evaluationDataset = await client.agents.evaluationDatasets.create(); console.log(evaluationDataset.evaluation_dataset_uuid); ``` ## Create File Upload Presigned URLs `client.agents.evaluationDatasets.createFileUploadPresignedURLs(EvaluationDatasetCreateFileUploadPresignedURLsParamsbody?, RequestOptionsoptions?): EvaluationDatasetCreateFileUploadPresignedURLsResponse` **post** `/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls` To create presigned URLs for evaluation dataset file upload, send a POST request to `/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls`. ### Parameters - `body: EvaluationDatasetCreateFileUploadPresignedURLsParams` - `files?: Array` A list of files to generate presigned URLs for. - `file_name?: string` Local filename - `file_size?: string` The size of the file in bytes. ### Returns - `EvaluationDatasetCreateFileUploadPresignedURLsResponse` Response with pre-signed urls to upload files. - `request_id?: string` The ID generated for the request for Presigned URLs. - `uploads?: Array` A list of generated presigned URLs and object keys, one per file. - `expires_at?: string` The time the url expires at. - `object_key?: string` The unique object key to store the file as. - `original_file_name?: string` The original file name. - `presigned_url?: string` The actual presigned URL the client can use to upload the file directly. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.evaluationDatasets.createFileUploadPresignedURLs(); console.log(response.request_id); ``` # Functions ## Create `client.agents.functions.create(stringagentUuid, FunctionCreateParamsbody?, RequestOptionsoptions?): FunctionCreateResponse` **post** `/v2/gen-ai/agents/{agent_uuid}/functions` To create a function route for an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/functions`. ### Parameters - `agentUuid: string` - `body: FunctionCreateParams` - `agent_uuid?: string` Agent id - `description?: string` Function description - `faas_name?: string` The name of the function in the DigitalOcean functions platform - `faas_namespace?: string` The namespace of the function in the DigitalOcean functions platform - `function_name?: string` Function name - `input_schema?: unknown` Describe the input schema for the function so the agent may call it - `output_schema?: unknown` Describe the output schema for the function so the agent handle its response ### Returns - `FunctionCreateResponse` Information about a newly function linked agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const _function = await client.agents.functions.create('"123e4567-e89b-12d3-a456-426614174000"'); console.log(_function.agent); ``` ## Update `client.agents.functions.update(stringfunctionUuid, FunctionUpdateParamsparams, RequestOptionsoptions?): FunctionUpdateResponse` **put** `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}` To update the function route, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. ### Parameters - `functionUuid: string` - `params: FunctionUpdateParams` - `body_agent_uuid?: string` Body param: Agent id - `description?: string` Body param: Funciton description - `faas_name?: string` Body param: The name of the function in the DigitalOcean functions platform - `faas_namespace?: string` Body param: The namespace of the function in the DigitalOcean functions platform - `function_name?: string` Body param: Function name - `function_uuid?: string` Body param: Function id - `input_schema?: unknown` Body param: Describe the input schema for the function so the agent may call it - `output_schema?: unknown` Body param: Describe the output schema for the function so the agent handle its response ### Returns - `FunctionUpdateResponse` The updated agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const _function = await client.agents.functions.update('"123e4567-e89b-12d3-a456-426614174000"', { path_agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(_function.agent); ``` ## Delete `client.agents.functions.delete(stringfunctionUuid, FunctionDeleteParamsparams, RequestOptionsoptions?): FunctionDeleteResponse` **delete** `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}` To delete a function route from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. ### Parameters - `functionUuid: string` - `params: FunctionDeleteParams` - `agent_uuid: string` The id of the agent the function route belongs to. ### Returns - `FunctionDeleteResponse` Information about a newly unlinked agent - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const _function = await client.agents.functions.delete('"123e4567-e89b-12d3-a456-426614174000"', { agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(_function.agent); ``` # Versions ## Update `client.agents.versions.update(stringpathUuid, VersionUpdateParamsbody?, RequestOptionsoptions?): VersionUpdateResponse` **put** `/v2/gen-ai/agents/{uuid}/versions` To update to a specific agent version, send a PUT request to `/v2/gen-ai/agents/{uuid}/versions`. ### Parameters - `pathUuid: string` - `body: VersionUpdateParams` - `body_uuid?: string` Agent unique identifier - `version_hash?: string` Unique identifier ### Returns - `VersionUpdateResponse` - `audit_header?: AuditHeader` An alternative way to provide auth information. for internal use only. - `actor_id?: string` - `actor_ip?: string` - `actor_uuid?: string` - `context_urn?: string` - `origin_application?: string` - `user_id?: string` - `user_uuid?: string` - `version_hash?: string` Unique identifier ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const version = await client.agents.versions.update('"123e4567-e89b-12d3-a456-426614174000"'); console.log(version.audit_header); ``` ## List `client.agents.versions.list(stringuuid, VersionListParamsquery?, RequestOptionsoptions?): VersionListResponse` **get** `/v2/gen-ai/agents/{uuid}/versions` To list all agent versions, send a GET request to `/v2/gen-ai/agents/{uuid}/versions`. ### Parameters - `uuid: string` - `query: VersionListParams` - `page?: number` Page number. - `per_page?: number` Items per page. ### Returns - `VersionListResponse` List of agent versions - `agent_versions?: Array` Agents - `id?: string` Unique identifier - `agent_uuid?: string` Uuid of the agent this version belongs to - `attached_child_agents?: Array` List of child agent relationships - `agent_name?: string` Name of the child agent - `child_agent_uuid?: string` Child agent unique identifier - `if_case?: string` If case - `is_deleted?: boolean` Child agent is deleted - `route_name?: string` Route name - `attached_functions?: Array` List of function versions - `description?: string` Description of the function - `faas_name?: string` FaaS name of the function - `faas_namespace?: string` FaaS namespace of the function - `is_deleted?: boolean` Whether the function is deleted - `name?: string` Name of the function - `attached_guardrails?: Array` List of guardrail version - `is_deleted?: boolean` Whether the guardrail is deleted - `name?: string` Guardrail Name - `priority?: number` Guardrail Priority - `uuid?: string` Guardrail UUID - `attached_knowledgebases?: Array` List of knowledge base agent versions - `is_deleted?: boolean` Deletet at date / time - `name?: string` Name of the knowledge base - `uuid?: string` Unique id of the knowledge base - `can_rollback?: boolean` Whether the version is able to be rolled back to - `created_at?: string` Creation date - `created_by_email?: string` User who created this version - `currently_applied?: boolean` Whether this is the currently applied configuration - `description?: string` Description of the agent - `instruction?: string` Instruction for the agent - `k?: number` K value for the agent's configuration - `max_tokens?: number` Max tokens setting for the agent - `model_name?: string` Name of model associated to the agent version - `name?: string` Name of the agent - `provide_citations?: boolean` Whether the agent should provide in-response citations - `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"` - `tags?: Array` Tags associated with the agent - `temperature?: number` Temperature setting for the agent - `top_p?: number` Top_p setting for the agent - `trigger_action?: string` Action triggering the configuration update - `version_hash?: string` Version hash - `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 versions = await client.agents.versions.list('"123e4567-e89b-12d3-a456-426614174000"'); console.log(versions.agent_versions); ``` # Knowledge Bases ## Attach `client.agents.knowledgeBases.attach(stringagentUuid, RequestOptionsoptions?): APILinkKnowledgeBaseOutput` **post** `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases` To attach knowledge bases to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases` ### Parameters - `agentUuid: string` ### Returns - `APILinkKnowledgeBaseOutput` Information about a linked knowledge base - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const apiLinkKnowledgeBaseOutput = await client.agents.knowledgeBases.attach( '"123e4567-e89b-12d3-a456-426614174000"', ); console.log(apiLinkKnowledgeBaseOutput.agent); ``` ## Attach Single `client.agents.knowledgeBases.attachSingle(stringknowledgeBaseUuid, KnowledgeBaseAttachSingleParamsparams, RequestOptionsoptions?): APILinkKnowledgeBaseOutput` **post** `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}` To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}` ### Parameters - `knowledgeBaseUuid: string` - `params: KnowledgeBaseAttachSingleParams` - `agent_uuid: string` A unique identifier for an agent. ### Returns - `APILinkKnowledgeBaseOutput` Information about a linked knowledge base - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const apiLinkKnowledgeBaseOutput = await client.agents.knowledgeBases.attachSingle( '"123e4567-e89b-12d3-a456-426614174000"', { agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"' }, ); console.log(apiLinkKnowledgeBaseOutput.agent); ``` ## Detach `client.agents.knowledgeBases.detach(stringknowledgeBaseUuid, KnowledgeBaseDetachParamsparams, RequestOptionsoptions?): KnowledgeBaseDetachResponse` **delete** `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}` To detach a knowledge base from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. ### Parameters - `knowledgeBaseUuid: string` - `params: KnowledgeBaseDetachParams` - `agent_uuid: string` Agent id ### Returns - `KnowledgeBaseDetachResponse` Informatinon about a unlinked knowledge base - `agent?: 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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.knowledgeBases.detach('"123e4567-e89b-12d3-a456-426614174000"', { agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(response.agent); ``` ## Domain Types ### API Link Knowledge Base Output - `APILinkKnowledgeBaseOutput` Information about a linked knowledge base - `agent?: 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` # Routes ## Update `client.agents.routes.update(stringchildAgentUuid, RouteUpdateParamsparams, RequestOptionsoptions?): RouteUpdateResponse` **put** `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}` To update an agent route for an agent, send a PUT request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. ### Parameters - `childAgentUuid: string` - `params: RouteUpdateParams` - `body_parent_agent_uuid?: string` Body param: A unique identifier for the parent agent. - `child_agent_uuid?: string` Body param: Routed agent id - `if_case?: string` Body param: Describes the case in which the child agent should be used - `route_name?: string` Body param: Route name - `uuid?: string` Body param: Unique id of linkage ### Returns - `RouteUpdateResponse` Information about an updated linkage - `child_agent_uuid?: string` Routed agent id - `parent_agent_uuid?: string` A unique identifier for the parent agent. - `rollback?: boolean` - `uuid?: string` Unique id of linkage ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const route = await client.agents.routes.update('"123e4567-e89b-12d3-a456-426614174000"', { path_parent_agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(route.child_agent_uuid); ``` ## Delete `client.agents.routes.delete(stringchildAgentUuid, RouteDeleteParamsparams, RequestOptionsoptions?): RouteDeleteResponse` **delete** `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}` To delete an agent route from a parent agent, send a DELETE request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. ### Parameters - `childAgentUuid: string` - `params: RouteDeleteParams` - `parent_agent_uuid: string` Pagent agent id ### Returns - `RouteDeleteResponse` Information about a removed linkage - `child_agent_uuid?: string` Routed agent id - `parent_agent_uuid?: string` Pagent agent id ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const route = await client.agents.routes.delete('"123e4567-e89b-12d3-a456-426614174000"', { parent_agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(route.child_agent_uuid); ``` ## Add `client.agents.routes.add(stringchildAgentUuid, RouteAddParamsparams, RequestOptionsoptions?): RouteAddResponse` **post** `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}` To add an agent route to an agent, send a POST request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. ### Parameters - `childAgentUuid: string` - `params: RouteAddParams` - `body_parent_agent_uuid?: string` Body param: A unique identifier for the parent agent. - `child_agent_uuid?: string` Body param: Routed agent id - `if_case?: string` Body param: - `route_name?: string` Body param: Name of route ### Returns - `RouteAddResponse` Information about a newly linked agent - `child_agent_uuid?: string` Routed agent id - `parent_agent_uuid?: string` A unique identifier for the parent agent. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.routes.add('"123e4567-e89b-12d3-a456-426614174000"', { path_parent_agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"', }); console.log(response.child_agent_uuid); ``` ## View `client.agents.routes.view(stringuuid, RequestOptionsoptions?): RouteViewResponse` **get** `/v2/gen-ai/agents/{uuid}/child_agents` To view agent routes for an agent, send a GET requtest to `/v2/gen-ai/agents/{uuid}/child_agents`. ### Parameters - `uuid: string` ### Returns - `RouteViewResponse` Child list for an agent - `children?: Array` Child agents - `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` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.agents.routes.view('"123e4567-e89b-12d3-a456-426614174000"'); console.log(response.children); ```