Patch Agent

Update metadata fields on the singleton agent.

Empty body short-circuits with no DB write and no reload. Any non-empty mutation flows through the 3-round reload pipeline.

PATCH /admin/api/v1/agent

Patch Agent

cURL

curl --request PATCH \
  --url https://api.example.com/admin/api/v1/agent \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "baseUrl": "<string>"
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "baseEngineConfig": {
      "agent": {
        "config": {
          "name": "<string>",
          "graph_definition": "<string>",
          "observability": {
            "provider": "<string>",
            "enabled": false,
            "options": {}
          },
          "checkpointer": {
            "type": "<string>",
            "db_url": "<string>"
          },
          "store": {}
        }
      },
      "server": {
        "api": {
          "port": 8000
        }
      },
      "mcpServers": [
        {
          "name": "<string>",
          "transport": "streamable_http",
          "url": "<string>",
          "command": "<string>",
          "args": [
            "<string>"
          ],
          "headers": {},
          "env": {},
          "cwd": "<string>",
          "encoding": "<string>",
          "timeoutSeconds": 123,
          "sseReadTimeoutSeconds": 123,
          "terminateOnClose": true,
          "sessionKwargs": {}
        }
      ],
      "guardrails": {
        "input": [
          {
            "banned_words": [
              "<string>"
            ],
            "config_id": "ban_list",
            "api_key": "",
            "reject_message": "ban!!",
            "guard_url": "hub://guardrails/ban_list"
          }
        ],
        "output": [
          {
            "banned_words": [
              "<string>"
            ],
            "config_id": "ban_list",
            "api_key": "",
            "reject_message": "ban!!",
            "guard_url": "hub://guardrails/ban_list"
          }
        ]
      },
      "observability": [
        {
          "config": {
            "provider": "LANGFUSE",
            "host": "https://cloud.langfuse.com",
            "publicKey": "",
            "secretKey": "",
            "runName": ""
          },
          "provider": "LANGFUSE",
          "enabled": true
        }
      ],
      "sso": {
        "issuer": "<string>",
        "clientId": "<string>",
        "enabled": true,
        "audience": "<string>",
        "allowedDomains": [
          "<string>"
        ],
        "allowedEmails": [
          "<string>"
        ]
      },
      "integrations": [
        {
          "config": {
            "accessToken": "<string>",
            "phoneNumberId": "<string>",
            "verifyToken": "<string>",
            "apiVersion": "v21.0"
          },
          "enabled": true
        }
      ],
      "prompts": [
        {
          "promptId": "<string>",
          "version": 123,
          "content": "<string>",
          "tags": [
            "<string>"
          ]
        }
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "slug": "<string>",
    "description": "<string>",
    "version": "<string>",
    "baseUrl": "<string>"
  },
  "reload": {
    "message": "<string>",
    "error": "<string>"
  }
}

Body

application/json

Body for PATCH /admin/api/v1/agent.

All fields are optional in the wire payload. Sending null on a required underlying column (name) is rejected at validation time, since clearing those is meaningless for the singleton.

name · string | null

description · string | null

version · string | null

baseUrl · string | null

Response

200

application/json

Successful Response

data · StandaloneAgentRead · object · required

GET response and the data payload of PATCH responses.

Show child attributes

reload · StandaloneReloadResult · object · required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Show child attributes