API Reference

Start synthetic research

post
https://v1.zigpoll.com/research/start

Starts AI-powered synthetic research on a poll, generating realistic survey responses using demographic personas and GPT-4. The generation runs asynchronously — this endpoint returns immediately. Use GET /research/status to monitor progress.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The ID of the poll to run synthetic research on

profiles
array of objects
required

Demographic profiles with weighted percentages (must sum to 100)

profiles*
integer
required
1 to 500

Number of synthetic responses to generate

string

Optional description of the survey's goal for better AI responses

string

Optional business context for more relevant responses

string

Language code (e.g. "en", "es", "fr"). Defaults to "en"

string

Full language name (e.g. "Spanish") — used to instruct GPT to respond in that language

Responses

409

Research is already running on this poll

422

Validation error. Returned when the poll is not configured for synthetic research (isSynthetic was not set to true at creation), input is invalid, or profile percentages don't sum to 100.

429

The run needs more synthetic submissions than remain this month. Each completion uses one submission per answerable question, so a run needs completionCount x questions. The body carries limit, used, remaining, required and maxCompletions (the largest completionCount that fits).

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?