For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with
index.html.mdin place of the HTML page (for example, appendindex.html.mdto the directory path instead of opening the HTML document).
dots.v2.genAi.agents.byAgent_uuId().get()
Generated on 27 Oct 2026
from DoTs version
v1.21.0
Usage
client.v2.genAi.agents.byAgent_uuId(agent_uuId).get(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | ApiGetAgentOutput>Description
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
agent_uuIdstring requiredExample:
"123e4567-e89b-12d3-a456-426614174000"Unique agent id
Request Sample
Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
createDigitalOceanClient,
DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";
const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);
const response = await client.v2.genAi.agents
.byAgent_uuId("\"123e4567-e89b-12d3-a456-426614174000\"").get();Response Example
Show Response Example
{
"agent": {
"anthropic_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"api_key_infos": [],
"api_keys": [],
"chatbot": {
"allowed_domains": [
"example string"
],
"button_background_color": "example string",
"logo": "example string",
"name": "example name",
"primary_color": "example string",
"secondary_color": "example string",
"starting_message": "example string"
},
"chatbot_identifiers": [],
"child_agents": [],
"conversation_logs_enabled": true,
"created_at": "2023-01-01T00:00:00Z",
"deployment": {
"created_at": "2023-01-01T00:00:00Z",
"name": "example name",
"status": "STATUS_UNKNOWN",
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"visibility": "VISIBILITY_UNKNOWN"
},
"description": "example string",
"functions": [],
"guardrails": [],
"if_case": "example string",
"instruction": "example string",
"k": 123,
"knowledge_bases": [],
"logging_config": {
"galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
"galileo_project_name": "example name",
"insights_enabled": true,
"insights_enabled_at": "2023-01-01T00:00:00Z",
"log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
"log_stream_name": "example name"
},
"max_tokens": 123,
"mcp_servers": [],
"model": {
"capabilities": [
"example string"
],
"context_window": "12345",
"created_at": "2023-01-01T00:00:00Z",
"endpoints": [],
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"kb_default_chunk_size": 123,
"kb_max_chunk_size": 123,
"kb_min_chunk_size": 123,
"lifecycle_status": "example string",
"name": "example name",
"parameter_count": 123,
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"reasoning_efforts": [
"example string"
],
"settings": [],
"thinking": true,
"type": "example string",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"model_provider_key": {
"api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [],
"name": "example name",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z"
},
"model_router": {
"created_at": "2023-01-01T00:00:00Z",
"description": "example string",
"name": "example name",
"regions": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"openai_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"parent_agents": [],
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"provide_citations": true,
"reasoning_effort": "example string",
"region": "example string",
"retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
"route_created_at": "2023-01-01T00:00:00Z",
"route_created_by": "12345",
"route_name": "example name",
"route_uuid": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example string"
],
"temperature": 123,
"template": {
"created_at": "2023-01-01T00:00:00Z",
"description": "example string",
"guardrails": [],
"instruction": "example string",
"k": 123,
"knowledge_bases": [],
"long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
"max_tokens": 123,
"name": "example name",
"short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
"summary": "example string",
"tags": [
"example string"
],
"temperature": 123,
"template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"thinking_token_budget": 123,
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"user_id": "12345",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version_hash": "example string",
"vpc_egress_ips": [
"example string"
],
"vpc_uuid": "\"12345678-1234-1234-1234-123456789012\"",
"web_fetch_enabled": true,
"web_search_enabled": true,
"workspace": {
"agents": [],
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"created_by_email": "[email protected]",
"deleted_at": "2023-01-01T00:00:00Z",
"description": "example string",
"evaluation_test_cases": [],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}
}More Information
See /v2/gen-ai/agents/{uuid} in the API reference for additional detail on responses, headers, parameters, and more.