Update agent configuration

Update the agent configuration identified by {sId} in the workspace identified by {wId}.

patch/api/v1/w/{wId}/assistant/agent_configurations/{sId}

Path parameters

wIdstring required

ID of the workspace

sIdstring required

ID of the agent configuration

Request body

userFavoriteboolean

instructionsstring

editorsstring[]

Emails of the workspace members to set as editors of the agent. Omitting this field keeps the current editors; providing it replaces the whole list.

Example request

{
  "editors": [
    "alice@example.com"
  ]
}

Response

Successfully updated agent configuration

Example response

{
  "agentConfiguration": {
    "id": 12345,
    "sId": "7f3a9c2b1e",
    "version": 2,
    "versionCreatedAt": "2023-06-15T14:30:00Z",
    "versionAuthorId": "0ec9852c2f",
    "name": "Customer Support Agent",
    "description": "An AI agent designed to handle customer support inquiries",
    "instructions": "Always greet the customer politely and try to resolve their issue efficiently.",
    "pictureUrl": "https://example.com/agent-images/support-agent.png",
    "status": "active",
    "scope": "workspace",
    "userFavorite": true,
    "model": {
      "providerId": "openai",
      "modelId": "gpt-4",
      "temperature": 0.7
    },
    "actions": [],
    "maxStepsPerRun": 10,
    "templateId": "b4e2f1a9c7"
  }
}

Changes

Changed in 5 of the 82 revisions of this API.152

Aug 13, 2026ad905257873c13See the full diff
- ▲
  the editors/items/ request property type/format changed from object/ to string/email
  request-property-type-changed
- ●
  removed the request property editors/items/email
  request-property-removed
- ●
  removed the request property editors/items/full_name
  request-property-removed
- ●
  removed the request property editors/items/user_id
  request-property-removed
Jul 8, 20262d1702fca1ee1See the full diff
- ○
  added the new optional request property toolset/items/configuration/mcp_server_name
  new-optional-request-property
Jun 19, 2026e5d6a51d91df1See the full diff
- ●
  removed the request property toolset/items/configuration/mcp_server_name
  request-property-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 17, 20268848d86acfa51See the full diff
- ○
  added the new optional request property toolset/items/configuration/mcp_server_name
  new-optional-request-property
Jun 7, 2026d541dc9c10e11See the full diff
- ●
  removed the request property toolset/items/configuration/mcp_server_name
  request-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history