Update Agent

PATCH 
/agent-studio/agent/versions/:versionId

Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration.

Request

Version stringrequired

API Version

Available optionsv3

versionId stringrequired

source string

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID for authorization

versionNamestring

Version name

descriptionstring

Description of the version

nodesobject[]

Complete array of nodes for the agent workflow. Provide all nodes including unchanged ones.

edgesobject[]

Complete array of edges connecting the nodes. Provide all edges including unchanged ones.

globalVariablesobject[]

Global variables accessible throughout the agent workflow

inputVariablesobject[]

Input variables required from user at execution time

runtimeVariablesobject[]

Runtime variables generated during agent execution

globalConfigobject

Global configuration including prompts and settings

userIdstring

User ID performing the update

userNamestring

User name performing the update

Example (auto)

{
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "versionName": "Customer Support Agent v2",
  "description": "Updated version with improved customer handling logic",
  "nodes": [
    {
      "nodeId": "node_1",
      "nodeName": "Start",
      "type": "start",
      "isStartNode": true
    },
    {
      "nodeId": "node_2",
      "nodeName": "LLM Node",
      "type": "llm",
      "nodeConfig": {
        "prompt": "How can I help you?",
        "llmProvider": "openai",
        "llmModel": "gpt-4"
      }
    }
  ],
  "edges": [
    {
      "startNode": "node_1",
      "endNode": "node_2"
    }
  ],
  "globalVariables": [
    {
      "key": "apiKey",
      "type": "string",
      "value": "your-api-key"
    }
  ],
  "inputVariables": [
    {
      "key": "customerName",
      "type": "string",
      "description": "Customer name for personalization"
    }
  ],
  "runtimeVariables": [
    {
      "key": "sessionId",
      "type": "string",
      "description": "Current session identifier"
    }
  ],
  "globalConfig": {
    "globalPrompt": {
      "currentPrompt": "You are a helpful customer support assistant.",
      "history": []
    }
  },
  "userId": "usr_abc123def456",
  "userName": "John Doe"
}

application/json

Version updated successfully

application/json

Schema

Schema

successbooleanrequired

Success status

messagestringrequired

Response message

dataobjectrequired

Updated agent or version data

Example (auto)

{
  "success": true,
  "message": "Agent updated successfully",
  "data": {
    "agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
    "versionId": "v1a2b3c4d5e6f7g8h9i0",
    "name": "Updated Customer Support Agent",
    "description": "Updated AI agent with enhanced customer support capabilities",
    "status": "active",
    "updatedAt": "2024-02-27T11:45:00.000Z"
  }
}