research

Start interview previews

Run one sample interview of a draft Research study: one customer twin of a business profile answers the edited questions once, skipping computer tasks. For an organization already subscribed to Point11 Analytics; the sample is unbilled and never appears in campaign lists or results. Returns the sample's run; read its transcript with research_interview_previews_get_v3.

post/api/v1/research/interview-previews/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/interview-previews/start
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

campaignNamestring required

The sample's name, e.g. "Brand health sample interview".

businessProfileIdstring uuid required

The business profile whose customer twin is interviewed.

targetedCustomerIdsstring[] required

Exactly one customer twin of the profile to interview.

playbookKey'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' required
researchFocusstring

The study's research focus, screened whole by acceptable use: at most 2,000 characters.

assumptionsstring[]

Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order; absent or empty when the study states none. Acceptable use screens each whole, so each is at most 2,000 characters, and none is empty.

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

runIdstring uuid required

The sample's run; read it with research.interview-previews.get.v2.

status'workflow_started' | 'encounter_coordination_required' required

How the sample's run starts.

campaignIdstring uuid required

The sample's own campaign, never listed or reported.

Changes

No recorded changes to this operation across all 1 revision of this API.