Skip to main content
GET

Overview

Returns the team behind your API key. Call it before a batch to know whether the videos will go through:
  • billingMode: managed means generation runs on Hooked’s provider keys and is paid with credits; byok means your team generates with its own provider keys (Settings → AI keys in the dashboard) and no credits are taken.
  • plan: the plan, its subscription status and the next renewal. A managed team needs a live plan (active, trialing or past_due) to generate.
  • credits.balance: credits left (the plan’s plus any extra credits). chargedForGeneration is true on managed and false on byok, where the balance is shown but not spent on generation.
  • storage: bytes used by your library and videos, and your plan’s limit.
  • keys (byok only, null on managed): one entry per provider with configured and status (ok, missing or invalid). Which keys a format needs is listed on each create page and in Creating videos.
Key values never leave Hooked: not the key, not a hint of it. Free and safe to call as often as you like.

Errors

Authorizations

x-api-key
string
header
required

Response

The account

success
boolean
required
data
object
required

The team behind the API key. Never contains a key value.

message
string