v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Basics

Create Prompts

Creates one or more prompts on a website. Returns the created prompt ids. Each prompt's geography (countries / primary_country) and any attached location_ids are validated for compatibility before insert.

post/api/v1/prompts

Request body

website_idstring uuid required

Website to create the prompts on.

source'manual' | 'ai_generated' | 'bulk_upload'

Attribution source (UI server action only; ignored for API-key callers).

Example request

{
  "prompts": [
    {
      "prompt": "best project management software",
      "type": "discovery",
      "volume": "1000",
      "current_monthly_searches": 5400,
      "current_total_value": 1250,
      "countries": [
        "United States",
        "France"
      ],
      "primary_country": "United States"
    }
  ]
}

Response

Prompts created

successboolean required

countinteger required

prompt_idsstring[] required

Example response

{
  "success": true,
  "count": 1
}