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

Retrieve an agent by UID

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

GET /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

Responses

200

Successful retrieval

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

404

Agent not found

Example request

bash

curl -X GET "https://a.api.mindset.ai/api/v1/appuid/{appUid}/agents/uid/{uid}" \
  -H "x-api-key: <your-api-key>"