Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.harmstack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to fetch information about the account associated with your API key, including your organization, account identifiers, and remaining credit balance.

Endpoint

GET https://api.harmstack.com/v0/me

Authentication

All requests must include your API key as a Bearer token.
Authorization
string
required
Bearer YOUR_API_KEY

Request

curl https://api.harmstack.com/v0/me \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

Returns 200 OK with a JSON body describing your account.
organization_id
number
required
The numeric ID of the organization your API key belongs to.
account_id
number
required
The numeric ID of the account associated with your API key.
available_credits
number
required
Your current credit balance. Credits are consumed each time you submit a benchmarking job.
{
  "organization_id": 42,
  "account_id": 7,
  "available_credits": 125.0
}
Each benchmarking job deducts credits from your balance equal to the benchmark_count you submit. Use this endpoint to check your balance before submitting large batches.