Skip to main content
POST
Start Response Streaming

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json
website_id
string<uuid>
required

Website to run the response streaming for.

prompt_ids
string<uuid>[]

Specific prompts to run (1–1,000). Omit to run all active prompts for the website. Only active prompts are executed: paused prompt IDs are accepted (the run still returns 201) but are silently skipped and never queued, so pass active prompt IDs.

selected_models
object

Map of model id to enabled flag (e.g. { "ai_overview": true, "ai_mode": false }). Omit to run every currently active model — this is not the dashboard's saved default selection. An explicit selection that resolves to no available models is rejected with 400.

prompt_variations
integer

Number of paraphrased variations to generate per prompt (0–10).

Required range: 0 <= x <= 10
use_personas
boolean

Whether to run the prompts through configured personas.

use_locations
boolean

Whether to run the prompts across the website's configured locations.

only_locations
boolean

When true, skip the base (non-localized) run and execute only the location-scoped variants. Requires use_locations: true: sending only_locations: true without use_locations: true queues nothing (the base run is skipped and no location variants are added), so the run completes as a no-op.

Response

Run started

workflow_id
string
required
status
enum<string>
required
Available options:
running