ORoriginalvoices
Ask

POST /v1/ask

Changed on

Ask a study's participants, a saved audience or an audience described in words up to 15 open and/or choice questions in one call. Each participant's Digital Twin answers them in order in one conversation, so an open question after a choice question can probe the pick; study participants also have their whole study conversation in context. Choice questions return per-option counts and percentages; every answer carries a low/medium/high confidence, and picks carry the model's reason. Replaces POST /v1/ask/open and POST /v1/ask/choices.

Request

  • Base URL
    https://api.originalvoices.ai
  • Auth
    HTTP bearer

Request body

filterstring

Study targets only. Free-text criteria matched against each participant's profile and what they said in the study, e.g. "said price was the main barrier".

twinIdsstring[]

Study targets: specific participants (twinIds from GET /v1/studies/{studyId}/participants); combines with filter. Saved-audience UUID targets: member twin ids (at most 100), echoed back as participants' twinId.

sampleSizeinteger

How many participants to ask. Defaults: interview studies ask everyone, twin-survey studies 25, saved and network audiences everyone up to 100, described audiences 25. Audiences take at most 100.

Response

Default Response

requestIdstring required
errorunknown required

Changes