CLIENT API / V1 CONTENT, BRIEFS & CAMPAIGNS

Read content generation revisions

GET/sites/{site_id}/content-generations/{generation_id}/revisions/{record_id}content:read

Read content generation revisions. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned. Lists omit large bodies; detail calls return stored payloads with bounded exports. Parent/child ownership is checked before artifact retrieval. GET never generates, revises, reviews or publishes content.

RequestGET https://satelliteai.io/api/v1/sites/{site_id}/content-generations/{generation_id}/revisions/{record_id}
Permissioncontent:read
ResponseA single object: data is ContentRevision.
Operation IDgetContentRevision

More context and worked examples are in the developer guide.

Example request

cURL · Bash
curl --fail-with-body \
  'https://satelliteai.io/api/v1/sites/123/content-generations/456/revisions/123' \
  -H "Authorization: Bearer $SATELLITE_API_KEY"

Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.

Parameters

NameInTypeDescription
site_idrequiredpathintegerAuthorized site id. Parent and site grants must also match.
min 1 · max 9223372036854775807
generation_idrequiredpathintegerAuthorized generation id. Parent and site grants must also match.
min 1 · max 9223372036854775807
record_idrequiredpathintegerAuthorized record id. Parent and site grants must also match.
min 1 · max 9223372036854775807

Unknown or repeated query parameters return 400.

Data dictionary

Scoped result. Lists return pagination metadata; unavailable records return 404. Stored authorized record. Fields depend on source availability and may be absent/null. Detail exports are capped at 2 MiB; larger artifacts return 413. Lists omit large bodies and structured review payloads.

[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.

Fields in data
FieldTypeDescription
data.idintegernullableId.
data.generation_idintegernullableGeneration id.
data.job_idstringnullableJob id.
data.revision_typestringnullableRevision type.
data.revision_requeststringnullableRevision request.
data.revised_contentstringnullableRevised content. Detail only; omitted from list rows.
data.word_countintegernullableWord count.
data.confidencenumber | stringnullableConfidence. Decimal values may be serialized as strings.
data.compliance_report_jsonanynullableCompliance report json. Detail only; omitted from list rows. Stored structured JSON; shape depends on the generation pipeline.
data.statusstringnullableStatus.
data.revision_numberintegernullableRevision number.
data.created_atstringnullableCreated at. Stored UTC ISO 8601 timestamp; legacy values may omit a timezone suffix.
data.updated_atstringnullableUpdated at. Stored UTC ISO 8601 timestamp; legacy values may omit a timezone suffix.
data.completed_atstringnullableCompleted at. Stored UTC ISO 8601 timestamp; legacy values may omit a timezone suffix.
data.truncated_fieldsarray of stringScalar text fields truncated at 200000 characters. Empty when no scalar was truncated.

Response metadata

Fields in meta
FieldTypeDescription
meta.request_idstringalways presentRequest identifier; also returned in X-Request-ID. Include it in support requests.
meta.api_versionstringalways presentAPI version that produced the response.
one of: v1
meta.limitintegerMaximum records per page applied to this request.
min 1 · max 100
meta.has_morebooleanTrue when another page is available.
meta.next_cursorstringnullableOpaque cursor for the next page; send as cursor. Null on the last page.
meta.availabilitystringavailable when stored data exists; not_available when it does not.
one of: available, not_available
meta.billingobjectPresent for paid live SERP requests; replayed receipts describe the original debit, not an additional charge.
meta.billing.operationstringalways present
one of: client_api_serp_refresh
meta.billing.credits_chargedintegeralways present
min 0
meta.billing.transaction_idintegeralways present
meta.billing.replayedbooleanalways present

Error responses

Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.

HTTPWhen
400Invalid parameters
401Invalid credentials
403Missing permission
404Missing or inaccessible resource
413artifact_too_large: the authorized stored export exceeds 2 MiB or bounded retrieval limits.
503artifact_unavailable or ownership_unavailable: stored artifact cannot be safely retrieved.