Mindset v3 / Deploy in your app / Agent Management (deprecated)

Update an agent by UID

Mindset v3 REST API reference: Agent Management (deprecated).

PATCH /api/v1/appuid/{appUid}/agents/uid/{uid}

Base URL

Requests go to your region's API host, for example https://a.api.mindset.ai. Hosts: https://a.api.mindset.ai, https://b.api.mindset.ai, https://c.api.mindset.ai, https://d.api.mindset.ai.

Authorization

x-api-keystringheaderrequired

Your API key.

Path parameters

appUidstringpathrequired

Your application's uid

uidstringpathrequired

Unique ID of the agent

Request body

Content type: application/json.

agentNamestringbody

Name of the agent

agentPurposestringbody

Purpose of the agent

formattingstringbody

Output formatting instructions

agentPersonalitystringbody

Personality of the agent

agentPolicyRulesstringbody

Policy rules for the agent

iceBreakerMessagestringbody

Invisible instruction to prompt the agent to greet users in a specific way or style

livebooleanbody

Activate the agent and make it live for end users

Default: false.

contextUidsstring[]body

Array of existing context Uids (max 30)

mcpserverUidsstring[]body

Array of existing MCP server Uids (max 5)

tagsstring[]body

Array of tags (max 10)

accessstringbody

Access control mode for this agent

One of: openAccess, restrictedAccess.

json

{
  "agentName": "string",
  "agentPurpose": "string",
  "formatting": "string",
  "agentPersonality": "string",
  "agentPolicyRules": "string",
  "iceBreakerMessage": "string",
  "live": true,
  "contextUids": [
    "string"
  ],
  "mcpserverUids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "access": "openAccess"
}

Responses

200

Successful update

json

{
  "uid": "string",
  "agentName": "string",
  "agentPurpose": "string",
  "formatting": "string",
  "agentPersonality": "string",
  "agentPolicyRules": "string",
  "iceBreakerMessage": "string",
  "live": true,
  "createdAt": "string",
  "contextUids": [
    "string"
  ],
  "mcpserverUids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "access": "openAccess",
  "externalTenantId": "string"
}

404

Agent not found

422

Unprocessable Entity

Example request

bash

curl -X PATCH "https://a.api.mindset.ai/api/v1/appuid/{appUid}/agents/uid/{uid}" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"agentName":"string","agentPurpose":"string","formatting":"string","agentPersonality":"string","agentPolicyRules":"string","iceBreakerMessage":"string","live":true,"contextUids":["string"],"mcpserverUids":["string"],"tags":["string"],"access":"openAccess"}'