agents

Update an Agent

Changed on

Updates an Agent's name, source_type, agent_type, or owner_id. Omitted fields keep their values. Changing or clearing owner_id additionally requires workspaces:manage; assigning an owner also requires workspaces:read and active workspace membership. Fleet ownership cannot be changed through this endpoint. Changing agent_type requires workspaces:manage in addition to project update access; repeating the current type is a no-op. Source type can change only for an EXTERNAL Agent without runtime bindings. The id is immutable and is rejected when present. Requires update permission on every environment project.

patch/api/v1/agents/{agent_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/agents/{agent_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

agent_idstring required

Agent ID

Request body

agent_type'CUSTOM' | 'CODING'
namestring

New display name. Omit to keep the current name.

owner_idstring uuid nullable

Omit to leave the owner unchanged; null clears it.

source_type'LSD' | 'MDA' | 'EXTERNAL' | 'FLEET'

Response

OK

agent_type'CUSTOM' | 'CODING' required
avatar_urlstring nullable

AvatarURL is a short-lived URL for the agent avatar, when present.

created_atstring date-time required
idstring required
namestring required
ownerstring

Owner is the owner's full name, falling back to email when available.

owner_idstring uuid nullable
source_type'LSD' | 'MDA' | 'EXTERNAL' | 'FLEET' required
tag_key_idstring uuid nullable
tag_value_idstring uuid nullable

Changes

  • d1aa6d438ff0Revision changes
    • info

      added the optional property to the response with the status

  • e45f16e950dcRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status