Skip to Content
API ReferenceAccountOverview

Account API

The Account API exposes read-only details about the account behind your API key: its profile, plan, and credit balance. It is a good first call when setting up an integration: confirm the key resolves to the expected account, then check credits before running work that consumes them.

Conventions

Requests use the base URL https://api.vdclip.com with the Authorization: Bearer vdck_... header. The API is server-to-server only and has no CORS.

Successful responses return resource data directly. Errors return an errors array. Both endpoints require the vdclip:account:read scope; a missing scope returns MISSING_SCOPE.

i
Credits gate the operations that cost

Operations that cost credits, such as rendering or publishing, return INSUFFICIENT_CREDITS when your balance is too low. Check GET /v1/credits first so your integration can pause or alert instead of failing. See the pricing page for plan tiers and credit allowances.

Endpoints

👤

Get account profile and plan

GET /v1/account

ViewConfirm the profile and plan tied to your API key
💳

Get credit balance

GET /v1/credits

ViewCheck available credits before running paid operations
Last updated on