SDK ReferenceTypeScript SDK

Account

Account info and API key management.

Account

Account info and API key management. Accessed via client.account.

get

client.account.get(): Promise<unknown>

GET /v1/account — get the authenticated account

apiKeys

create

client.account.apiKeys.create(opts: Record<string, unknown>): Promise<unknown>

POST /v1/account/api-keys — create a new API key

list

client.account.apiKeys.list(): Promise<unknown>

GET /v1/account/api-keys — list all API keys for the account

get

client.account.apiKeys.get(id: ApiKeyId): Promise<unknown>

GET /v1/account/api-keys/{id} — get an API key by ID

update

client.account.apiKeys.update(id: ApiKeyId, opts: Record<string, unknown>): Promise<unknown>

PATCH /v1/account/api-keys/{id} — update an API key

revoke

client.account.apiKeys.revoke(id: ApiKeyId): Promise<unknown>

DELETE /v1/account/api-keys/{id} — revoke an API key (idempotent)

reveal

client.account.apiKeys.reveal(id: ApiKeyId): Promise<RevealApiKeyResponse>

POST /v1/account/api-keys/{id}/reveal — reveal the plaintext API key value