Retrieve your account

Check a key: the workspace it belongs to, its kind, and the workspace's credits. It spends nothing.

GEThttps://www.skipshoot.com/api/v1/me

Updated October 28, 2026

On this page

Request
Response
Errors

The first call to make with a new key. It spends nothing, and says which workspace the key belongs to and how many credits that workspace has left.

Request

No parameters.

Response

workspace.namestring: The name of the workspace the key belongs to.
key.kindstring: secret.
key.modestring: live: renders made with the key are real and spend credits.
credits.usedinteger: Credits spent in the current period. It starts again from 0 when the credits renew, which is every month, including on yearly plans.
credits.limitinteger | null: Credits for the period, or null when the workspace has no fixed limit, as on Enterprise.
credits.remaininginteger | null: limit minus used, never below 0, or null when limit is.

Credits are shared with everything your workspace renders, in the app and through the API. See Credits, billing and refunds.

Errors

Status	Type	When
401	`authentication_required`	No key was sent.
401	`invalid_api_key`	The key is not valid or was revoked.
403	`key_kind_not_allowed`	A publishable key was sent.
429	`rate_limited`	Too many requests this minute.

Request

curl https://www.skipshoot.com/api/v1/me \
  -H "Authorization: Bearer $SKIPSHOOT_SECRET_KEY"

Response

{
  "workspace": {
    "name": "Northwind Textiles"
  },
  "key": {
    "kind": "secret",
    "mode": "live"
  },
  "credits": {
    "used": 312,
    "limit": 1500,
    "remaining": 1188
  }
}

Something these pages do not answer? Email admin@skipshoot.com and we’ll help.