Update agent

PUT/api/agents/{id}

Updates mutable fields on an existing workspace agent.

Path Parameters

id*string

Resource identifier.

Example"agent_123"

Request Body

application/json

Request payload for Update agent.

name?|

Display name for the agent.

description?|

Optional summary of the agent's responsibility.

prompt?|

Optional system prompt override for the agent.

customModel?|

Optional model identifier pinned for this agent.

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/agents/agent_123" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "agent_123",
  "workspaceId": "ws_123",
  "name": "Renewals assistant",
  "description": "Helps account managers follow up on renewals.",
  "icon": "bot",
  "color": "#1d4ed8",
  "data": {},
  "createdAt": "2026-04-01T12:00:00.000Z",
  "updatedAt": "2026-04-01T12:00:00.000Z",
  "deletedAt": "2026-04-01T12:00:00.000Z"
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Update agent

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`