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>",
  "live": false,
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "restrictedAccess"
}'
{
  "uid": "<string>",
  "agentName": "<string>",
  "agentPurpose": "<string>",
  "formatting": "<string>",
  "agentPersonality": "<string>",
  "agentPolicyRules": "<string>",
  "live": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "openAccess"
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum 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 - 500
formatting
string

Output formatting instructions

Required string length: 1 - 500
agentPersonality
string

Personality of the agent

Maximum length: 500
agentPolicyRules
string

Policy rules for the agent

Maximum length: 500
live
boolean
default:false

Agent is active and live for end users

contextUids
string[]

Array of existing context Uids (max 30)

Maximum length: 30
mcpserverUids
string[]

Array of existing MCP server Uids (max 5)

Maximum length: 5
tags
string[]

Array of tags (max 10)

Maximum length: 10
access
enum<string>
default:restrictedAccess

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

Available options:
openAccess,
restrictedAccess

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

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 length: 30
mcpserverUids
string[]

Array of existing MCP server Uids (max 5)

Maximum length: 5
tags
string[]

Array of tags (max 10)

Maximum length: 10
access
enum<string>
Available options:
openAccess,
restrictedAccess
I