Base URL
Authentication
All requests require an API key in theX-Api-Key header:
Authentication Guide
How to get and use API keys.
Quick Example
Transaction Schema
Context
Onlybillable_customer_id is required. Add any additional context fields you need. They will appear in your dashboard and can be used for filtering, alerts, and reports.
Usage
Theusage field describes what resources an AI call consumed. Different AI operations consume different resources:
- Text generation (GPT, Claude, etc.) consumes tokens
- Image generation (DALL-E, etc.) consumes images
- Speech-to-text/TTS (Whisper, etc.) consumes audio seconds
usage field is an array because some AI calls consume multiple resource types. For example, a GPT-4 Vision request might consume both tokens (for text) and process images.
Structure of a usage entry:
type: The resource type (see table below)metrics: The measurements for that resource
Usage Types
Example: Text Generation (Most Common)
Example: Multimodal (Multiple Resource Types)
A request that generates both text and images:Response Codes
Error Reference
Complete list of error codes and how to handle them.
Endpoints
POST /usage/transactions
Send one or more AI usage transactions.