Update Agent Version | Humanloop Docs

curl -X PATCH https://api.humanloop.com/v5/agents/ag_1234567890/versions/agv_1234567890 \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "teller-agent-v2",
  "description": "Updated version"
}'

{
  "path": "Banking/Teller Agent",
  "id": "ag_1234567890",
  "model": "claude-3-7-sonnet-latest",
  "tools": [
    {
      "type": "file",
      "link": {
        "file_id": "pr_1234567890",
        "version_id": "prv_1234567890"
      },
      "on_agent_call": "continue"
    },
    {
      "type": "inline",
      "json_schema": {
        "name": "stop",
        "description": "Call this tool when you have finished your task.",
        "strict": true,
        "parameters": {
          "type": "object",
          "properties": {
            "output": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "output"
          ]
        }
      },
      "on_agent_call": "stop"
    }
  ],
  "name": "Teller Agent",
  "version_id": "agv_1234567890",
  "created_at": "2024-05-01T12:00:00Z",
  "updated_at": "2024-05-01T12:00:00Z",
  "status": "committed",
  "last_used_at": "2024-05-01T12:00:00Z",
  "version_logs_count": 1,
  "total_logs_count": 1,
  "inputs": [],
  "endpoint": "chat",
  "template": [
    {
      "role": "system",
      "content": "You are a helpful digital assistant, helping users navigate our digital banking platform."
    }
  ],
  "provider": "anthropic",
  "reasoning_effort": 1024,
  "max_iterations": 3,
  "type": "agent",
  "environments": [
    {
      "id": "env_ffSVxEBzJcBZ1H5jcNMVj",
      "created_at": "2023-06-27T23:16:07.992339",
      "name": "development",
      "tag": "default"
    }
  ],
  "created_by": {
    "id": "usr_01RJO1k2spBVqNUt1ASef",
    "email_address": "raza@humanloop.com",
    "full_name": "Raza Habib"
  },
  "evaluator_aggregates": null
}

Update the name or description of the Agent version.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Agent.

version_idstringRequired

Unique identifier for the specific version of the Agent.

Request

This endpoint expects an object.

namestringOptional

Name of the version.

descriptionstringOptional

Description of the version.

Response

Successful Response

Errors

422

Patch Agent Version Agents ID Versions Version ID Patch Request Unprocessable Entity Error