General
GET
/

Returns API metadata and the workspace the key resolved to, including its plan, credit balance, plan limits and current usage. This is the cheapest way to verify a key: it reads nothing beyond the workspace the transport already loaded.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings > API & Webhooks. Keys start with sf_live_.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com"
{  "data": {    "name": "ShortFast API",    "version": "v1",    "docs": "https://developer.shortfast.com",    "workspace": {      "id": "k9WmT3xR2pQ7nV4bd",      "name": "Acme Studio",      "plan": "pro",      "credits": {        "credits": 42500,        "tokens": 42500000      },      "limits": {        "maxRendersPerMonth": 100,        "maxAutomations": 5,        "maxProfiles": 3,        "maxVideoDurationSeconds": 900,        "maxRenderSeconds": 900,        "storageBytes": 21474836480,        "watermark": false      },      "usage": {        "storageBytes": 3187441664,        "profiles": 2      }    }  }}