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

Create a new agent

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

POST /api/v1/appuid/{appUid}/agents

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

Request body

Content type: application/json.

agentNamestringbodyrequired

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

Agent is active and 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. Use Agent Sessions with restrictedAccess agents.

One of: openAccess, restrictedAccess. Default: "restrictedAccess".

externalTenantIdstringbody

External tenant identifier. Valid characters are A-Za-z0-9_-.

json

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

Responses

201

Agent created successfully

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"
}

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

500

Internal Server Error

Example request

bash

curl -X POST "https://a.api.mindset.ai/api/v1/appuid/{appUid}/agents" \
  -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","externalTenantId":"string"}'