Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List

API Reference
Agents
Versions
List Agent Versions
get/v2/gen-ai/agents/{uuid}/versions

To list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.

Path ParametersExpand Collapse
uuid: string
Query ParametersExpand Collapse
page: optional number

Page number.

per_page: optional number

Items per page.

ReturnsExpand Collapse
agent_versions: optional array of object { id, agent_uuid, attached_child_agents, 20 more }

Agents

id: optional string

Unique identifier

formatuint64
agent_uuid: optional string

Uuid of the agent this version belongs to

attached_child_agents: optional array of object { agent_name, child_agent_uuid, if_case, 2 more }

List of child agent relationships

agent_name: optional string

Name of the child agent

child_agent_uuid: optional string

Child agent unique identifier

if_case: optional string

If case

is_deleted: optional boolean

Child agent is deleted

route_name: optional string

Route name

attached_functions: optional array of object { description, faas_name, faas_namespace, 2 more }

List of function versions

description: optional string

Description of the function

faas_name: optional string

FaaS name of the function

faas_namespace: optional string

FaaS namespace of the function

is_deleted: optional boolean

Whether the function is deleted

name: optional string

Name of the function

attached_guardrails: optional array of object { is_deleted, name, priority, uuid }

List of guardrail version

is_deleted: optional boolean

Whether the guardrail is deleted

name: optional string

Guardrail Name

priority: optional number

Guardrail Priority

formatint64
uuid: optional string

Guardrail UUID

attached_knowledgebases: optional array of object { is_deleted, name, uuid }

List of knowledge base agent versions

is_deleted: optional boolean

Deletet at date / time

name: optional string

Name of the knowledge base

uuid: optional string

Unique id of the knowledge base

can_rollback: optional boolean

Whether the version is able to be rolled back to

created_at: optional string

Creation date

formatdate-time
created_by_email: optional string

User who created this version

currently_applied: optional boolean

Whether this is the currently applied configuration

description: optional string

Description of the agent

instruction: optional string

Instruction for the agent

k: optional number

K value for the agent's configuration

formatint64
max_tokens: optional number

Max tokens setting for the agent

formatint64
model_name: optional string

Name of model associated to the agent version

name: optional string

Name of the agent

provide_citations: optional boolean

Whether the agent should provide in-response citations

retrieval_method: optional 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
tags: optional array of string

Tags associated with the agent

temperature: optional number

Temperature setting for the agent

formatfloat
top_p: optional number

Top_p setting for the agent

formatfloat
trigger_action: optional string

Action triggering the configuration update

version_hash: optional string

Version hash

Links to other pages

meta: optional APIMeta

Meta information about the data set

curl https://api.digitalocean.com/v2/gen-ai/agents/$UUID/versions \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
{
  "agent_versions": [
    {
      "id": "12345",
      "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "attached_child_agents": [
        {
          "agent_name": "example name",
          "child_agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "if_case": "example string",
          "is_deleted": true,
          "route_name": "example name"
        }
      ],
      "attached_functions": [
        {
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "is_deleted": true,
          "name": "example name"
        }
      ],
      "attached_guardrails": [
        {
          "is_deleted": true,
          "name": "example name",
          "priority": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "attached_knowledgebases": [
        {
          "is_deleted": true,
          "name": "example name",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "can_rollback": true,
      "created_at": "2023-01-01T00:00:00Z",
      "created_by_email": "[email protected]",
      "currently_applied": true,
      "description": "example string",
      "instruction": "example string",
      "k": 123,
      "max_tokens": 123,
      "model_name": "example name",
      "name": "example name",
      "provide_citations": true,
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "top_p": 123,
      "trigger_action": "example string",
      "version_hash": "example string"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}
Returns Examples
{
  "agent_versions": [
    {
      "id": "12345",
      "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "attached_child_agents": [
        {
          "agent_name": "example name",
          "child_agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "if_case": "example string",
          "is_deleted": true,
          "route_name": "example name"
        }
      ],
      "attached_functions": [
        {
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "is_deleted": true,
          "name": "example name"
        }
      ],
      "attached_guardrails": [
        {
          "is_deleted": true,
          "name": "example name",
          "priority": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "attached_knowledgebases": [
        {
          "is_deleted": true,
          "name": "example name",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "can_rollback": true,
      "created_at": "2023-01-01T00:00:00Z",
      "created_by_email": "[email protected]",
      "currently_applied": true,
      "description": "example string",
      "instruction": "example string",
      "k": 123,
      "max_tokens": 123,
      "model_name": "example name",
      "name": "example name",
      "provide_citations": true,
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "top_p": 123,
      "trigger_action": "example string",
      "version_hash": "example string"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}