Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

Who this token belongs to

GET
/v1/keys/whoami
curl --request GET \
--url https://example.com/v1/keys/whoami \
--header 'Authorization: Bearer <token>'

What the portal needs on first paint: who you are, whether you are staff, and how many live credentials you hold.

Successful Response

Media typeapplication/json
WhoAmIResponse

Who a Cognito token belongs to, as the portal needs it on first paint.

object
email
required
Email
string
superadmin
required
Superadmin

Easting staff. Reaches the product without a subscription.

boolean
stripe_customer_id
Any of:
string
active_keys
required
Active Keys
integer
Examplegenerated
{
"email": "example",
"superadmin": true,
"stripe_customer_id": "example",
"active_keys": 1
}

Missing, unknown, or revoked API key

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
"error": {
"documents_used": 200,
"message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
"monthly_cap": 200,
"resets_on": "2026-08-01",
"type": "quota_exceeded"
}
}

Extraction temporarily unavailable

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
"error": {
"documents_used": 200,
"message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
"monthly_cap": 200,
"resets_on": "2026-08-01",
"type": "quota_exceeded"
}
}