Account | Pendium MCP Docs | Pendium.ai
Pendium MCP Docs

Account

Check your plan, credit balance, and list all your brand agents.

GET /api/visibility/account

Authentication: Required

See your account at a glance — what plan you're on, how many credits you have left, and all the brand agents tied to your API key. This is a good first call to make when setting up an integration.

Example

curl https://pendium.ai/api/visibility/account \
  -H "x-api-key: pk_live_xxxxxxxxxxxx"

Response

{
  "plan": "starter",
  "creditBalance": 450,
  "creditWarning": null,
  "agentCount": 2,
  "agents": [
    {
      "syntheticId": 1234,
      "name": "Acme Corp",
      "website": "https://acme.com",
      "lastScanDate": "2026-03-15T10:00:00Z",
      "latestScore": 62
    },
    {
      "syntheticId": 1235,
      "name": "Acme Blog",
      "website": "https://blog.acme.com",
      "lastScanDate": null,
      "latestScore": null
    }
  ],
  "upgradeUrl": "https://pendium.ai/pricing",
  "_pendium": {
    "what_you_are_seeing": "Your account overview with 2 brand agents..."
  }
}

Key fields

FieldWhat it tells you
planYour current plan: free, starter, or pro
creditBalanceHow many credits you have left. Scans cost credits depending on mode and query count.
creditWarningnull if you're fine. A warning message if credits are low or at zero.
agentsEvery brand agent you own, with their IDs, names, and latest scan info. Use the syntheticId values in other API calls.
agents[].latestScoreThe most recent visibility score (0–100), or null if no scan has been run yet.

Teams

If you're part of a team, agents includes both agents you own directly and agents shared with you through team groups.

On this page