wallet.get
The video-time balance
GET/wallet
How many seconds of finished video this account can still make, by bucket: a plan's seconds for the current billing month (which end with the period), top up seconds (which never expire), free seconds, and what is currently held by work in flight. availableSeconds is the one number a reservation is judged against.
curl 'https://api.gogoscreen.com/api/v1/wallet' \
-H "Authorization: Bearer $GOGOSCREEN_API_KEY"{
"wallet": {
"planSeconds": 0,
"planId": null,
"planExpiresAt": null,
"planActive": false,
"paygSeconds": 542,
"freeSeconds": 0,
"reservedSeconds": 0,
"availableSeconds": 542
}
}At a glance
| Fact | Detail |
|---|---|
| Scopes | wallet:read |
| Credentials | a signed in dashboard session or an API key. |
| Rate limit | 600 requests a minute per credential, in the read class. |
| Idempotency | Not applicable. This operation changes nothing. |
| MCP tool | wallet_get |
| Always sets | Cache-Control: private, no-store |
200 OK
The video-time balance
| Name | Type | Description | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| wallet | object | ||||||||||||||||||||||||||||
8 fields inside wallet
| |||||||||||||||||||||||||||||
| Header | Meaning |
|---|---|
Cache-Control | Always private, no-store. |
Errors
Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.
| Code | Status | When it happens | What to do |
|---|---|---|---|
| validation_failed | 400 | The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored. | Read details.issues. Each entry carries a path, a message and a machine readable code. Fix every named field and send the request again; the same body always fails the same way. |
| unauthorized | 401 | No credential was presented, or the key is unknown, revoked or expired, or an X-API-Key header carried something that is not an API key. details.reason says which. | Send Authorization: Bearer gsk_live_…. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in Authorization, never in X-API-Key. |
| forbidden_scope | 403 | The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. keys.* and assistant.* are user only and can never be called by a key. | details.requiredScopes and details.missingScopes name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When details.allowedActors is present, no key can call this operation at all. |
| not_found | 404 | No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403. | Check the id. Do not treat this as a permissions problem. |
| rate_limited | 429 | The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. details.scope is minute, day or account, or global when the product's own daily cap on voice previews is spent. | Wait the Retry-After seconds and retry. details.limit and details.resetAt say what was hit and when it reopens. The RateLimit-* headers on every answer let a client pace itself before it gets here. |
| internal_error | 500 | An unhandled failure inside this API. The original message is logged and never answered. | Retry once, then quote requestId to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe. |