Read prompt
Read one saved record from prompts.
GET
/projects/{projectId}/prompts/{id}Required permission
data:readThe key must include this project and its owner must still have access.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
idstringRequiredIdentifier from the corresponding resource list.
Response fields
dataobjectRequiredRead one saved record from prompts.
Child fields
idstringRequiredUnique identifier for this record.
projectIdstringRequiredProject that owns this record.
categoryIdstring | nullRequiredSaved category id.
textstringRequiredSaved text.
marketstringRequiredSaved market.
languagestringRequiredSaved language.
brandedbooleanRequiredSaved branded.
intentstringRequiredSaved intent.
followUpsJSONRequiredFollow-up questions in their saved order.
activebooleanRequiredSaved active.
archivedbooleanRequiredSaved archived.
targetUrlstring | nullRequiredSaved target url.
createdAtISO 8601 timestampRequiredWhen this record was saved, in UTC.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.