Skip to main content
GET
/
api
/
v2
/
appuid
/
{appUid}
/
agents
/
uid
/
{uid}
Retrieve an agent by UID
curl --request GET \
  --url https://a.api.mindset.ai/api/v2/appuid/{appUid}/agents/uid/{uid} \
  --header 'x-api-key: <api-key>'
{
  "uid": "<string>",
  "agentName": "<string>",
  "agentPurpose": "<string>",
  "personality": {
    "preset": "friendly",
    "customText": "<string>"
  },
  "formatting": {
    "preset": "conversational",
    "customText": "<string>"
  },
  "policies": {
    "focusAndScope": {
      "enabled": false,
      "scope": "<string>"
    },
    "knowledgeLimits": {
      "enabled": false,
      "themeSpecificAllowance": "<string>"
    },
    "nonContextSegmentMessage": {
      "enabled": false,
      "message": "<string>"
    },
    "clarification": {
      "enabled": false
    },
    "recommendations": {
      "enabled": false
    },
    "neutrality": {
      "enabled": false
    },
    "professionalConduct": {
      "enabled": false
    },
    "legalFinancial": {
      "enabled": false
    },
    "safeguarding": {
      "enabled": false,
      "email": "[email protected]"
    },
    "feedback": {
      "enabled": false
    }
  },
  "additionalPolicyRules": "<string>",
  "additionalInformation": "<string>",
  "iceBreakerMessage": "<string>",
  "memory": {
    "allowAccess": false,
    "allowContribution": false,
    "miningGuidance": "<string>"
  },
  "live": true,
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "openAccess",
  "externalTenantId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum string length: 1
uid
string
required

Unique ID of the agent

Response

Successful retrieval

uid
string

Unique ID of the agent

agentName
string

Name of the agent

agentPurpose
string

Purpose of the agent

personality
object

Agent personality configuration

formatting
object

Agent response formatting configuration

policies
object

Agent policy configuration with 10 toggleable policies

additionalPolicyRules
string

Additional free-form policy rules

additionalInformation
string

Additional context information for the agent

iceBreakerMessage
string

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

memory
object

Agent memory configuration. Note: Memory access must be enabled at the app level for these settings to take effect.

live
boolean

Agent is active and live for end users

contextUids
string[]

Array of context UIDs

mcpserverUids
string[]

Array of MCP server UIDs

tags
string[]

Array of tags

access
enum<string>

Access control mode

Available options:
openAccess,
restrictedAccess
externalTenantId
string

External tenant identifier

createdAt
string<date-time>

Creation timestamp (ISO 8601)