Skip to main content
POST
Add prompts to a brand report

Authorizations

Authorization
string
header
required

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

Path Parameters

reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Body

application/json
promptIds
string[]
required

IDs of prompts that already exist in the report workspace — look them up with GET /v1/workspaces/{id}/prompts. Up to 1000 IDs per call. Duplicate IDs are removed, and the de-duplicated list comes back as promptIds in the response.

Required array length: 1 - 1000 elements
Required string length: 1 - 64

Response

The prompts assigned to the brand report. Recalculation completes asynchronously.

reportId
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

promptIds
string[]
required

The prompt IDs the request asked to assign.

added
string[]
required

Prompt IDs newly assigned to the report by this request.

alreadyAssigned
string[]
required

Prompt IDs that were already assigned to the report, left unchanged.