Agents

Update agent configuration

Changed on

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

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

Request

Path parameters

wIdstring required

ID of the workspace

sIdstring required

ID of the agent configuration

Request body

userFavoriteboolean

Favorites the agent for the calling user. Requires a user; rejected with 400 when authenticated with a workspace API key.

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,
    "agentModelId": 6789,
    "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": [],
    "skills": [
      {
        "sId": "skill_abc123",
        "name": "Customer Support"
      }
    ],
    "tags": [
      {
        "sId": "3f9d1c7a5b",
        "name": "Support"
      }
    ],
    "requestedSpaceIds": [
      "vlt_a1b2c3d4e5"
    ],
    "maxStepsPerRun": 10,
    "templateId": "b4e2f1a9c7"
  }
}

Changes

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status