agent_routes

Creates, updates, deletes, gets or lists an agent_routes resource.

Overview

Name	agent_routes
Type	Resource
Id	digitalocean.genai.agent_routes

Fields

The following fields are returned by SELECT queries:

genai_get_agent_children

A successful response.

Name	Datatype	Description
name	string	Agent name (example: example name)
project_id	string	(example: 123e4567-e89b-12d3-a456-426614174000)
user_id	string (uint64)	Id of user that created the agent (example: 12345)
route_name	string	Route name (example: example name)
anthropic_api_key	object	Anthropic API Key Info
api_key_infos	array	Api key infos
api_keys	array	Api keys
chatbot	object	A Chatbot
chatbot_identifiers	array	Chatbot identifiers
child_agents	array	Child agents
conversation_logs_enabled	boolean	Whether conversation logs are enabled for the agent
created_at	string (date-time)	Creation date / time (example: 2023-01-01T00:00:00Z)
deployment	object	Description of deployment
description	string	Description of agent (example: example string)
functions	array
guardrails	array	The guardrails the agent is attached to
if_case	string	(example: example string)
instruction	string	Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices. (example: example string)
k	integer (int64)
knowledge_bases	array	Knowledge bases
logging_config	object
max_tokens	integer (int64)
model	object	Description of a Model
openai_api_key	object	OpenAI API Key Info
parent_agents	array	Parent agents
provide_citations	boolean	Whether the agent should provide in-response citations
region	string	Region code (example: example string)
retrieval_method	string	- RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries - RETRIEVAL_METHOD_NONE: The retrieval method is none (default: RETRIEVAL_METHOD_UNKNOWN, example: RETRIEVAL_METHOD_UNKNOWN)
route_created_at	string (date-time)	Creation of route date / time (example: 2023-01-01T00:00:00Z)
route_created_by	string (uint64)	(example: 12345)
route_uuid	string	(example: 123e4567-e89b-12d3-a456-426614174000)
tags	array	Agent tag to organize related resources
temperature	number (float)
template	object	Represents an AgentTemplate entity
top_p	number (float)
updated_at	string (date-time)	Last modified (example: 2023-01-01T00:00:00Z)
url	string	Access your agent under this url (example: example string)
uuid	string	Unique agent id (example: 123e4567-e89b-12d3-a456-426614174000)
version_hash	string	The latest version of the agent (example: example string)
workspace	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
genai_get_agent_children	select	uuid		To view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child_agents.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
uuid	string	Agent id (example: "123e4567-e89b-12d3-a456-426614174000")

SELECT examples

genai_get_agent_children

To view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child_agents.

SELECT
name,
project_id,
user_id,
route_name,
anthropic_api_key,
api_key_infos,
api_keys,
chatbot,
chatbot_identifiers,
child_agents,
conversation_logs_enabled,
created_at,
deployment,
description,
functions,
guardrails,
if_case,
instruction,
k,
knowledge_bases,
logging_config,
max_tokens,
model,
openai_api_key,
parent_agents,
provide_citations,
region,
retrieval_method,
route_created_at,
route_created_by,
route_uuid,
tags,
temperature,
template,
top_p,
updated_at,
url,
uuid,
version_hash,
workspace
FROM digitalocean.genai.agent_routes
WHERE uuid = '{{ uuid }}' -- required;