Get API key usage

Retrieve usage analytics and billing data for a specific API key.

cURL

Get usage for the last 30 days (default)

curl -X GET 'https://admin-api.exa.ai/team-management/api-keys/{id}/usage' \
  -H 'x-api-key: YOUR-SERVICE-KEY'

200

{
  "id": "key_abc123def456",
  "api_key_id": "550e8400-e29b-41d4-a716-446655440000",
  "api_key_name": "Production API Key",
  "team_id": "660e8400-e29b-41d4-a716-446655440000",
  "period": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-01-31T23:59:59Z"
  },
  "total_cost_usd": 45.67,
  "cost_breakdown": [
    {
      "price_id": "price_neural_search",
      "price_name": "Neural Search",
      "quantity": 1000,
      "amount_usd": 30
    },
    {
      "price_id": "price_content_retrieval",
      "price_name": "Content Retrieval",
      "quantity": 500,
      "amount_usd": 15.67
    }
  ],
  "metadata": {
    "generated_at": "2025-02-01T10:30:00Z"
  }
}

Get your Exa API key

Create a key in the dashboard. New accounts start with free credits.

The Team Management API is enabled per team. It authenticates with a service account API key, which is created from the Service keys tab on the API keys page once the feature is enabled for your team. Contact [e-mail] to request access.

​

Important Notes

• Lookback Limit: A start_date older than 180 days returns 400.
• Zero Usage: If the API key has no usage in the requested period, total_cost_usd will be 0 and cost_breakdown may be empty.
• Team Ownership: The service API key used for authentication must belong to the same team as the requested API key. Cross-team access is not permitted.
• Date Formats: Dates can be provided in ISO 8601 format with or without time components (e.g., 2025-01-01 or 2025-01-01T00:00:00Z).

Authorizations

x-api-key · string · header · required

Service API key for team authentication

Path Parameters

id · string · required

The key's publicId. The key's current secret is also accepted for backward compatibility.

Query Parameters

start_date · string<date-time>

Start date for the usage period (ISO 8601 format). Defaults to 30 days ago. Must be within the last 6 months (180 days).

end_date · string<date-time>

End date for the usage period (ISO 8601 format). Defaults to current time.

group_by · enum<string>

Has no effect on the response.

Available options: hour, day, month

Response

200

application/json

Usage data retrieved successfully

id · string

The key's publicId, its stable identifier.

api_key_id · string<uuid>

The API key's secret, kept for backward compatibility. Despite the field name it is not an identifier; use id to identify the key.

api_key_name · string | null

The name of the API key

team_id · string<uuid>

The team ID this key belongs to

period · object

Show child attributes

total_cost_usd · number

Total cost in USD for the period

Example:

45.67

cost_breakdown · object[]

Breakdown of costs by price type

Show child attributes

metadata · object

Show child attributes