Home · Docs · Schemas · PostsEnvelope
PostsEnvelope — the wrapper around a posts response
Every posts endpoint answers with this envelope. Eight fields, all required: you can read `success` and `credits_used` without checking whether they came.
PostsEnvelope has 8 fields: 2 nullable, 8 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 |
cached | boolean | no | yes |
request_id | string | no | yes |
8 rows above, 0 of them with a transcription from the contract and 0 with a note of ours.
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 · ProfileEnvelope