ApiframeApiframe Docs
Account

Get Account Info

Retrieve your user and team information.

GET /v2/me

Returns information about the authenticated user, their team, and the API key used for the request.

Response

{
  "user": {
    "id": "d4e5f6a7-b8c9-0123-def4-567890123456",
    "email": "[email protected]",
    "role": "ADMIN"
  },
  "team": {
    "id": "e5f6a7b8-c9d0-1234-ef56-789012345678",
    "name": "My Team",
    "plan": "pro",
    "credits": 4500,
    "maxConcurrentJobs": 10
  },
  "apiKey": {
    "id": "f6a7b8c9-d0e1-2345-f678-901234567890",
    "name": "Production Key"
  }
}

Response fields

User

FieldTypeDescription
idstringUnique user ID
emailstringUser email address
rolestringRole within the team: "ADMIN" or "MEMBER"

Team

FieldTypeDescription
idstringTeam ID
namestringTeam display name
planstringCurrent subscription plan (e.g. "free", "pro", "business")
creditsnumberRemaining credit balance
maxConcurrentJobsnumberMaximum number of jobs that can run simultaneously

API Key

FieldTypeDescription
idstringAPI key ID
namestringDisplay name you gave the key

Code example

curl -H "X-API-Key: afk_your_api_key_here" \
  https://api.apiframe.ai/v2/me
import requests

response = requests.get(
    "https://api.apiframe.ai/v2/me",
    headers={"X-API-Key": "afk_your_api_key_here"},
)
data = response.json()
print(f"Credits remaining: {data['team']['credits']}")
const response = await fetch("https://api.apiframe.ai/v2/me", {
  headers: { "X-API-Key": "afk_your_api_key_here" },
});
const { user, team } = await response.json();
console.log(`${user.email} — ${team.credits} credits remaining`);

Try it

GET/v2/meTry it

On this page