research

Start study designs

Deprecated: use research.study-designs.start.v2 (research_study_designs_start_v2), which also takes a study video; this version takes none and leaves a video out of the study it returns. Design a custom Research study from a conversation with Alpha: send the brief so far (the last message is the user's), any study files already uploaded with research.study-attachments, and the draft's name, goal and questions. Returns the run and either the design (Alpha's reply and a complete editable study, or no study when the brief cannot become one) or pending; poll research.study-designs.get.v1 with this request's Idempotency-Key. It charges the organization's Alpha credits. Designs belong to the signed-in user's draft, so an API key cannot start one.

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

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-designs/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

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 required

The business profile the study is designed for.

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.