Skip to main content
POST
/
api
/
v1
/
appuid
/
{appUid}
/
agents
Create a new agent
curl --request POST \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentName": "<string>",
  "agentPurpose": "<string>",
  "formatting": "<string>",
  "agentPersonality": "<string>",
  "agentPolicyRules": "<string>",
  "iceBreakerMessage": "<string>",
  "live": false,
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "restrictedAccess",
  "externalTenantId": "<string>"
}
'
{
  "uid": "<string>",
  "agentName": "<string>",
  "agentPurpose": "<string>",
  "formatting": "<string>",
  "agentPersonality": "<string>",
  "agentPolicyRules": "<string>",
  "iceBreakerMessage": "<string>",
  "live": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "openAccess",
  "externalTenantId": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum string length: 1

Body

application/json
agentName
string
required

Name of the agent

Required string length: 1 - 50
agentPurpose
string

Purpose of the agent

Required string length: 1 - 1000
formatting
string

Output formatting instructions

Required string length: 1 - 500
agentPersonality
string

Personality of the agent

Maximum string length: 500
agentPolicyRules
string

Policy rules for the agent

Maximum string length: 500
iceBreakerMessage
string

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

Maximum string length: 1000
live
boolean
default:false

Agent is active and live for end users

contextUids
string[]

Array of existing context Uids (max 30)

Maximum array length: 30
Required string length: 1 - 30
mcpserverUids
string[]

Array of existing MCP server Uids (max 5)

Maximum array length: 5
Required string length: 20
tags
string[]

Array of tags (max 10)

Maximum array length: 10
Required string length: 1 - 60
access
enum<string>
default:restrictedAccess

Access control mode for this agent. Use Agent Sessions with restrictedAccess agents.

Available options:
openAccess,
restrictedAccess
externalTenantId
string

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

Maximum string length: 100

Response

Agent created successfully

uid
string

Unique ID of the agent

agentName
string

Name of the agent

agentPurpose
string

Purpose of the agent

formatting
string

Output formatting instructions

agentPersonality
string

Personality of the agent

agentPolicyRules
string

Policy rules for the agent

iceBreakerMessage
string

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

live
boolean
default:false

Activate the agent and make it live for end users

createdAt
string<date-time>

Creation timestamp (ISO 8601)

contextUids
string[]

Array of existing context Uids (max 30)

Maximum array length: 30
Required string length: 1 - 30
mcpserverUids
string[]

Array of existing MCP server Uids (max 5)

Maximum array length: 5
Required string length: 20
tags
string[]

Array of tags (max 10)

Maximum array length: 10
Required string length: 1 - 60
access
enum<string>
Available options:
openAccess,
restrictedAccess
externalTenantId
string

External tenant identifier

Maximum string length: 100