Sign in

v1

latestOpenAPI 3.0.02026-07-222980136.7 KB
Prompts

Create prompts in a workspace

Creates one prompt (prompt) or several (prompts) in the workspace and starts monitoring them, exactly like creation in the UI (including search-volume computation). Up to 5 prompts are created synchronously (201 with the created items); larger batches are processed asynchronously (202 with a processing summary). The whole batch is validated against the workspace's remaining prompt allocation up front — nothing is created if it would exceed the limit.

post/v1/workspaces/{id}/prompts

Path parameters

idstring required

Workspace identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Workspace identifier.

Request body

promptsstring[] required

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

countrystring required

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

tagIdsstring[]

Optional tag IDs to assign to every created prompt.

brandReportIdsstring[]

Optional brand report IDs to add every created prompt to.

Example request

{
  "prompts": [
    "best running shoes",
    "best trail shoes"
  ],
  "country": "us",
  "tagIds": []
}

Response

The created prompts.

Example response

{
  "items": [
    {
      "id": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
      "prompt": "best running shoes",
      "country": "us",
      "tagIds": [],
      "brandReportIds": [],
      "createdDate": "2026-07-14T10:00:00.000Z"
    }
  ]
}