Get Account
Reference for the GET /v1/me endpoint.
GET /v1/me
Returns the identity and plan information for the authenticated API key. Use this to confirm your key is valid before submitting extractions.
Response 200 OK
Response Properties
| Field | Type | Description |
|---|---|---|
user.user_id | string | Unique user identifier. |
user.email | string | Account email address. |
user.name | string | Display name, if set. |
user.credits_available | integer | Total non-expired credits remaining. |
user.key_name | string | Human-readable label for this API key. |
user.key_expires_at | string | null | Key expiry, or null if the key never expires. |
user.member_since | string | Account creation timestamp (ISO 8601). |
Common Error Responses
| HTTP Status | Error Code | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing API key. |