Skip to main content
POST
Create prompts in a workspace

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Workspace identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Body

application/json
prompts
string[]
required

Prompt texts to create (same country, tags and brand reports for all). Pass a single-item array to create one prompt.

Minimum array length: 1
Minimum string length: 1
country
string
required

Country the prompts are monitored in. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom. Immutable after creation.

Pattern: ^[a-z]{2}$
tagIds
string[]

Optional tag IDs to assign to every created prompt.

Minimum string length: 1
brandReportIds
string[]

Optional brand report IDs to add every created prompt to.

Minimum string length: 1

Response

The created prompts.

items
object[]
required