Home · Docs · Schemas · ProfileEnvelope
ProfileEnvelope — the wrapper, and where your credits stand
The profile envelope carries the credit accounting that the posts envelope does not: what this call cost, what is left of the monthly allowance, and what you bought.
ProfileEnvelope has 13 fields: 6 nullable, 9 guaranteed by the contract's required list. Every number on this page is counted from the field map at render time — none of them is written down.
Fields
| Field | Type | Nullable | Required |
|---|---|---|---|
success | boolean | no | yes |
platform | string | no | yes |
endpoint | string | no | yes |
data | object | yes | yes |
error | object | yes | yes |
credits_used | integer | no | yes |
credits_remaining | integer | yes | yes |
credits_purchased_remaining | integer | yes | no |
free_credits_remaining | integer | yes | no |
free_credits_total | integer | yes | no |
free_credits_reset_at | string | no | no |
cached | boolean | no | yes |
request_id | string | no | yes |
13 rows above, 6 of them with a transcription from the contract and 1 with a note of ours.
What the fields mean
Only the fields with something measured or decided about them appear here. A field whose name and type say everything gets no paragraph, rather than a generic one.
credits_remaining
From the contract: THE SUM: purchased balance plus what is left of this month's free allowance. This is the only number that answers "can I call again" — it is not 0 while you can still call. null means we could not read it, which is not the same as zero.
credits_purchased_remaining
From the contract: Bought credits. These never expire.
free_credits_remaining
From the contract: What is left of this month's free allowance.
free_credits_total
From the contract: The monthly free allowance for this key.
free_credits_reset_at
From the contract: When the free allowance resets: 00:00 UTC on the 1st. It is here so the sum dropping at the turn of the month is expected rather than a surprise.
cached
From the contract: `true` is a promise that we did NOT charge: it always comes with `credits_used: 0`.
Our note: true is a promise that we did not charge for this call.
How this page stays true
The field list, the two flags and the closed value sets are generated from the contract this API serves, and a test compares them against the live /openapi.json in both directions: a field in the contract with no documentation fails, a documented field the contract does not have fails, and a wrong nullable or required fails. The prose marked our note is not covered by that test — it is authored, and labelled so you can tell.
The machine-readable source is at /openapi.json. If you are generating a client, use that rather than this page.
The other 7 schemas
ApiError · SeriesPoint · Item · Mover · Author · PostItem · PostsEnvelope