Skip to content
ansvra.Documentation
Prompts
Prompts

Create prompt

Create one prompt. Account allowances and project availability apply.

POST/projects/{projectId}/prompts
Required permission prompts:write

The key must include this project and its owner must still have access.

Authentication and permissions · Errors and limits

Authorization

Authorizationstring · headerRequired

Bearer access key. Never put a key in the URL.

Idempotency-Keystring · headerRequired

Required for creation: 1–128 letters, numbers, dots, underscores, colons or hyphens. Reuse for retries of the same request within 24 hours.

Path parameters

projectIdstringRequired

Project identifier from List projects.

Request body

application/json. Unknown fields are rejected.

textstringRequired

Question text, 1–10,000 characters.

categoryIdstring | nullOptional

Category in this project. Creation without a category uses General.

marketstringRequired

Supported country code.

languagestringOptional

Must match the market’s language when supplied.

followUpsstring[]Optional

Up to four questions, each 1–10,000 characters.

Default: []

intentstringOptional

learn, compare, buy or find_brand.

Default: learn

brandedbooleanOptional

Whether this question names a brand.

Default: false

activebooleanOptional

Whether the prompt is active. Existing enabled tracking can include active prompts.

Default: true

Response fields

dataobjectRequired

Create one prompt. Account allowances and project availability apply.

Child fields
idstringRequired

Unique identifier for this record.

projectIdstringRequired

Project that owns this record.

categoryIdstring | nullRequired

Saved category id.

textstringRequired

Saved text.

marketstringRequired

Saved market.

languagestringRequired

Saved language.

brandedbooleanRequired

Saved branded.

intentstringRequired

Saved intent.

followUpsJSONRequired

Follow-up questions in their saved order.

activebooleanRequired

Saved active.

archivedbooleanRequired

Saved archived.

targetUrlstring | nullRequired

Saved target url.

createdAtISO 8601 timestampRequired

When this record was saved, in UTC.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
requestIdstringRequired

Request identifier to include when contacting support.

resultScope"saved"Required

Saved customer information; excludes Overview preview results.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…