Skip to main content

List Agent Profiles

Overview​

The admin-list-agent-profiles tool returns all current (IsCurrent = 1) agent profiles. This is useful for dashboard dropdowns, configuration UIs, and verification scripts.

Tool ID: admin-list-agent-profiles

The examples use the direct runtime/operator route. Replit/Admin UI browser code should call the Admin UI BFF instead: local /admin-api/*, testing /dashboard/admin-api/*.

Input Schema​

No input parameters required - simply send an empty data object.

{} // Empty object

Example Usage​

curl -s -X POST "${MASTRA_BASE_URL}/admin/tools/list-agent-profiles" \
  -H "Content-Type: application/json" \
  -H "Ocp-Apim-Subscription-Key: $SUBSCRIPTION_KEY" \
  -d '{}'
const response = await fetch(`${MASTRA_BASE_URL}/admin/tools/list-agent-profiles`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.BEARER_TOKEN}`,
  },
  body: JSON.stringify({})
});

const profiles = await response.json();
profiles.forEach(p => {
  console.log(`${p.agentId} (${p.agentAlias}) - v${p.version}`);
});

Output​

Returns an array of profile objects:

[
  {
    agentId: string;           // Agent identifier
    agentAlias: string;        // Human-readable name
    version: number;           // Current version number
    promptHash: string;        // Hash of the prompt
    systemPrompt: string;      // Full prompt text
    llmOverrides?: object;     // LLM parameters (if any)
    createdAt: string;         // ISO timestamp
    createdBy: string;         // Creator
  },
  // ... more profiles
]

Use Cases​

  • Dashboard Display: Populate agent selection dropdowns
  • Health Monitoring: Verify expected agents are configured
  • Audit Reports: List all active agents and their configurations
  • Testing: Validate profile deployment in different environments