m4Mindset docs

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

View as Markdown

Retrieve agents

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

GET /api/v1/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",
      "formatting": "string",
      "agentPersonality": "string",
      "agentPolicyRules": "string",
      "iceBreakerMessage": "string",
      "live": true,
      "createdAt": "string",
      "contextUids": [
        "string"
      ],
      "mcpserverUids": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "access": "openAccess",
      "externalTenantId": "string"
    }
  ]
}

401

Unauthorized

403

Forbidden

404

Agent not found

500

Internal Server Error

Example request

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