List

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 Parameters

uuidstring

Query Parameters

pagenumber

optional

Page number.

per_pagenumber

optional

Items per page.

Returns

agent_versionsarray of object

optional

Agents

Hide ParametersShow Parameters

idstring

optional

Unique identifier

formatuint64

agent_uuidstring

optional

Uuid of the agent this version belongs to

attached_child_agentsarray of object

optional

List of child agent relationships

Hide ParametersShow Parameters

agent_namestring

optional

Name of the child agent

child_agent_uuidstring

optional

Child agent unique identifier

if_casestring

optional

If case

is_deletedboolean

optional

Child agent is deleted

route_namestring

optional

Route name

attached_functionsarray of object

optional

List of function versions

Hide ParametersShow Parameters

descriptionstring

optional

Description of the function

faas_namestring

optional

FaaS name of the function

faas_namespacestring

optional

FaaS namespace of the function

is_deletedboolean

optional

Whether the function is deleted

namestring

optional

Name of the function

attached_guardrailsarray of object

optional

List of guardrail version

Hide ParametersShow Parameters

is_deletedboolean

optional

Whether the guardrail is deleted

namestring

optional

Guardrail Name

prioritynumber

optional

Guardrail Priority

formatint64

uuidstring

optional

Guardrail UUID

attached_knowledgebasesarray of object

optional

List of knowledge base agent versions

Hide ParametersShow Parameters

is_deletedboolean

optional

Deletet at date / time

namestring

optional

Name of the knowledge base

uuidstring

optional

Unique id of the knowledge base

can_rollbackboolean

optional

Whether the version is able to be rolled back to

created_atstring

optional

Creation date

formatdate-time

created_by_emailstring

optional

User who created this version

currently_appliedboolean

optional

Whether this is the currently applied configuration

descriptionstring

optional

Description of the agent

instructionstring

optional

Instruction for the agent

knumber

optional

K value for the agent's configuration

formatint64

max_tokensnumber

optional

Max tokens setting for the agent

formatint64

model_namestring

optional

Name of model associated to the agent version

namestring

optional

Name of the agent

provide_citationsboolean

optional

Whether the agent should provide in-response citations

retrieval_methodAPIRetrievalMethod

optional

• 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

tagsarray of string

optional

Tags associated with the agent

temperaturenumber

optional

Temperature setting for the agent

formatfloat

top_pnumber

optional

Top_p setting for the agent

formatfloat

trigger_actionstring

optional

Action triggering the configuration update

version_hashstring

optional

Version hash

linkspagesobjectAPILinks

optional

Links to other pages

metapagenumberpagesnumbertotalnumberAPIMeta

optional

Meta information about the data set

HTTPPython

curl https://api.digitalocean.com//v2/gen-ai/agents/$UUID/versions \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

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