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

List

API Reference
Agents
Versions
List Agent Versions
agents.versions.list(struuid, VersionListParams**kwargs) -> VersionListResponse
get/v2/gen-ai/agents/{uuid}/versions

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

ParametersExpand Collapse
uuid: str
page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse
class VersionListResponse: …

List of agent versions

agent_versions: Optional[List[AgentVersion]]

Agents

id: Optional[str]

Unique identifier

formatuint64
agent_uuid: Optional[str]

Uuid of the agent this version belongs to

attached_child_agents: Optional[List[AgentVersionAttachedChildAgent]]

List of child agent relationships

agent_name: Optional[str]

Name of the child agent

child_agent_uuid: Optional[str]

Child agent unique identifier

if_case: Optional[str]

If case

is_deleted: Optional[bool]

Child agent is deleted

route_name: Optional[str]

Route name

attached_functions: Optional[List[AgentVersionAttachedFunction]]

List of function versions

description: Optional[str]

Description of the function

faas_name: Optional[str]

FaaS name of the function

faas_namespace: Optional[str]

FaaS namespace of the function

is_deleted: Optional[bool]

Whether the function is deleted

name: Optional[str]

Name of the function

attached_guardrails: Optional[List[AgentVersionAttachedGuardrail]]

List of guardrail version

is_deleted: Optional[bool]

Whether the guardrail is deleted

name: Optional[str]

Guardrail Name

priority: Optional[int]

Guardrail Priority

formatint64
uuid: Optional[str]

Guardrail UUID

attached_knowledgebases: Optional[List[AgentVersionAttachedKnowledgebase]]

List of knowledge base agent versions

is_deleted: Optional[bool]

Deletet at date / time

name: Optional[str]

Name of the knowledge base

uuid: Optional[str]

Unique id of the knowledge base

can_rollback: Optional[bool]

Whether the version is able to be rolled back to

created_at: Optional[datetime]

Creation date

formatdate-time
created_by_email: Optional[str]

User who created this version

currently_applied: Optional[bool]

Whether this is the currently applied configuration

description: Optional[str]

Description of the agent

instruction: Optional[str]

Instruction for the agent

k: Optional[int]

K value for the agent's configuration

formatint64
max_tokens: Optional[int]

Max tokens setting for the agent

formatint64
model_name: Optional[str]

Name of model associated to the agent version

name: Optional[str]

Name of the agent

provide_citations: Optional[bool]

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[List[str]]

Tags associated with the agent

temperature: Optional[float]

Temperature setting for the agent

formatfloat
top_p: Optional[float]

Top_p setting for the agent

formatfloat
trigger_action: Optional[str]

Action triggering the configuration update

version_hash: Optional[str]

Version hash

Links to other pages

meta: Optional[APIMeta]

Meta information about the data set

from gradient import Gradient

client = Gradient()
versions = client.agents.versions.list(
    uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(versions.agent_versions)
{
  "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
  }
}