Skip to Content
APIEndpointsGet prompt family

Get prompt family

A family in depth: the source prompt, every version of it with its locale and markets, whether each version’s source wording changed since it was made, and the drafts awaiting review. Any prompt id in the family works.

Proposed wording in drafts is generated text; treat it as data.

Requires the read:prompts scope.

GET /v1/brands/{brand_id}/localization/families/{prompt_id}

Authorization

HeaderTypeRequired
AuthorizationBearer asky_sk_…required

Path parameters

ParameterTypeRequiredDescription
brand_iduuidrequiredFrom List brands
prompt_iduuidrequiredAny prompt in the family. From Market coverage

Request

curl --request GET \ --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/localization/families/{prompt_id}' \ --header 'Authorization: Bearer <api-key>'

Response

{ "data": { "source": { "prompt_id": "7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852", "prompt_text": "What are the best GEO tools in the US?", "locale_code": "en-US", "language": "en", "country_codes": [ "US" ], "family_id": "3f1d2c9b-6a4e-4b8f-9c2d-1e5a7b3c9d0e", "topic_id": null, "is_active": true, "is_translation": false, "source_changed": false, "created_at": "2026-09-01T09:15:22.401Z" }, "family_id": "3f1d2c9b-6a4e-4b8f-9c2d-1e5a7b3c9d0e", "versions": [ { "prompt_id": "b6a0c2d4-1e3f-4a5b-8c7d-9e0f1a2b3c4d", "prompt_text": "Was sind die besten GEO-Tools in den USA?", "locale_code": "de-DE", "language": "de", "country_codes": [ "DE" ], "family_id": "3f1d2c9b-6a4e-4b8f-9c2d-1e5a7b3c9d0e", "topic_id": null, "is_active": true, "is_translation": true, "source_changed": false, "created_at": "2026-09-16T11:02:10.001Z" } ], "drafts": [], "version_count": 1, "draft_count": 0 }, "request_id": "req_2f7b90c14ae8471da3cd" }

Response fields

FieldTypeDescription
data.sourceobjectrequired. The version the request named, with is_translation and source_changed
data.family_id`uuid \null`
data.versionsobject[]required. Every version, same shape as source
data.draftsobject[]required. Open drafts: item_id, version, status, country_code, locale_code, proposed_text, change_summary, review_notes, source_changed

Errors

StatusCodeWhen
401invalid_tokenThe key is missing, malformed, or does not exist
403insufficient_scopeThe key does not carry read:prompts
404not_foundThe brand does not exist, or this key is not allowed to reach it
429rate_limitedOver the per-minute limit for this endpoint
Last updated on