Mindset v3 / Deploy in your app / Agent Configuration

Retrieve agents

Mindset v3 REST API reference: Agent Configuration.

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

Query parameters

contextUidstringquery

Filter results to a specific contextUid. Cannot be used with mcpserverUid

mcpserverUidstringquery

Filter results to a specific mcpserverUid. Cannot be used with contextUid

externalTenantIdstringquery

Only include Agents for externalTenantId

startAfterstringquery

Start after the given createdAt timestamp (ISO 8601) for pagination

Responses

200

Successful retrieval

json

{
  "agents": [
    {
      "uid": "string",
      "agentName": "string",
      "agentPurpose": "string",
      "personality": {
        "preset": "friendly",
        "customText": "string"
      },
      "formatting": {
        "preset": "conversational",
        "customText": "string"
      },
      "policies": {
        "focusAndScope": {
          "enabled": null,
          "scope": null
        },
        "knowledgeLimits": {
          "enabled": null,
          "themeSpecificAllowance": null
        },
        "nonContextSegmentMessage": {
          "enabled": null,
          "message": null
        },
        "clarification": {
          "enabled": null
        },
        "recommendations": {
          "enabled": null
        },
        "neutrality": {
          "enabled": null
        },
        "professionalConduct": {
          "enabled": null
        },
        "legalFinancial": {
          "enabled": null
        },
        "safeguarding": {
          "enabled": null,
          "email": null
        },
        "feedback": {
          "enabled": null
        }
      },
      "additionalPolicyRules": "string",
      "additionalInformation": "string",
      "iceBreakerMessage": "string",
      "memory": {
        "allowAccess": true,
        "allowContribution": true,
        "miningGuidance": "string"
      },
      "options": {
        "showSourceContent": true,
        "sourceDisplayStyle": "compact",
        "sourceCardType": "segments",
        "showSpeakers": true,
        "showFollowUpQuestions": true,
        "showCitations": true,
        "showQuickReplies": true
      },
      "live": true,
      "showPromptLibrary": true,
      "contextUids": [
        "string"
      ],
      "mcpserverUids": [
        "string"
      ],
      "planUids": [
        "string"
      ],
      "skillUids": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "access": "openAccess",
      "externalTenantId": "string",
      "createdAt": "string"
    }
  ]
}

401

Unauthorized

403

Forbidden

422

Unprocessable Entity - Invalid query parameters

500

Internal Server Error

Example request

bash

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