research

Start study designs (v3)

Supports original MP3 and WAV audio alongside the existing study media. Prepare a custom Research instrument from creative files and a brief as a member or organization API key. Supply profileId for grounded business context, or null for creative-only feedback, and optionally contentLanguage (the profile's language when omitted). Unknown needs and buying situations remain assumptions. Returns a durable design run; read research_study_designs_get_v3 with the same Idempotency-Key. Uses the existing Alpha credit allowance. This operation prepares the study; research_campaigns_launch executes its interviews.

post/api/v1/research/study-designs/start-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-designs/start-v3
  • Auth: one of:
    • HTTP bearer
    • 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

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

Always custom: only a custom study is designed.

profileIdstring uuid nullable required

Seller business profile, or null for creative-only study context.

contentLanguage'en' | 'fr' | 'es' | 'de' | 'pt' | 'ja' | 'it' | 'nl' | 'sv' | 'cs' | 'pl' | 'tr' | 'ru' | 'zh-Hans' | 'ko' | 'ar'

The language the study is written in. Omit it to write in the profile's language, as Research's own setup page does.

Response

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

runIdstring uuid required

The billing run that pays for the design in Alpha credits.

status'pending' | 'ready' required

Changes

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