Skip to content

get_user_info

Returns the account behind the API key — subscription plan, remaining publishing credits, and AI token balance. Useful as a connection smoke test: if this returns 200, your key is wired up correctly.

On this page
  1. Parameters
  2. Example request
  3. Response
Category
Account
REST
POST/api/tools/get_user_info

Parameters

workspaceId
stringoptional
Workspace to act on, from list_workspaces. Omit to use the default workspace on the key.

Example request

curl -X POST "https://api.postmcpai.com/api/tools/get_user_info" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $POSTMCPAI_API_KEY"

Response

A single object describing the authenticated account.

200 · application/json
{
  "name": "Alex Johnson",
  "email": "[email protected]",
  "plan": "PRO",
  "credits": 450,
  "aiToken": 12500
}