Create prompt
Create one prompt. Account allowances and project availability apply.
/projects/{projectId}/promptsprompts:writeThe 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.
Idempotency-Keystring · headerRequiredRequired for creation: 1–128 letters, numbers, dots, underscores, colons or hyphens. Reuse for retries of the same request within 24 hours.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Request body
application/json. Unknown fields are rejected.
textstringRequiredQuestion text, 1–10,000 characters.
categoryIdstring | nullOptionalCategory in this project. Creation without a category uses General.
marketstringRequiredSupported country code.
languagestringOptionalMust match the market’s language when supplied.
followUpsstring[]OptionalUp to four questions, each 1–10,000 characters.
Default:
[]intentstringOptionallearn, compare, buy or find_brand.
Default:
learnbrandedbooleanOptionalWhether this question names a brand.
Default:
falseactivebooleanOptionalWhether the prompt is active. Existing enabled tracking can include active prompts.
Default:
true
Response fields
dataobjectRequiredCreate one prompt. Account allowances and project availability apply.
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.