List

API Reference

Agents

Versions

List Agent Versions

client.agents.versions.list(stringuuid, VersionListParams { page, per_page } query?, RequestOptionsoptions?): VersionListResponse { agent_versions, links, meta }

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: string

query: VersionListParams { page, per_page }

page?: number

Page number.

per_page?: number

Items per page.

ReturnsExpand Collapse

VersionListResponse { agent_versions, links, meta }

List of agent versions

agent_versions?: Array<AgentVersion>

Agents

id?: string

Unique identifier

formatuint64

agent_uuid?: string

Uuid of the agent this version belongs to

attached_child_agents?: Array<AttachedChildAgent>

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<AttachedFunction>

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<AttachedGuardrail>

List of guardrail version

is_deleted?: boolean

Whether the guardrail is deleted

name?: string

Guardrail Name

priority?: number

Guardrail Priority

formatint64

uuid?: string

Guardrail UUID

attached_knowledgebases?: Array<AttachedKnowledgebase>

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

formatdate-time

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

formatint64

max_tokens?: number

Max tokens setting for the agent

formatint64

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

Accepts one of the following:

"RETRIEVAL_METHOD_UNKNOWN"

"RETRIEVAL_METHOD_REWRITE"

"RETRIEVAL_METHOD_STEP_BACK"

"RETRIEVAL_METHOD_SUB_QUERIES"

"RETRIEVAL_METHOD_NONE"

tags?: Array<string>

Tags associated with the agent

temperature?: number

Temperature setting for the agent

formatfloat

top_p?: number

Top_p setting for the agent

formatfloat

trigger_action?: string

Action triggering the configuration update

version_hash?: string

Version hash

links?: APILinks { pages }

Links to other pages

pages?: Pages { first, last, next, previous }

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 { page, pages, total }

Meta information about the data set

page?: number

The current page

formatint64

pages?: number

Total number of pages

formatint64

total?: number

Total amount of items over all pages

formatint64

List Agent Versions

typescript

• http
• typescript
• python

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);

200 example

{
  "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

200 example

{
  "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
  }
}