---
title: "Start study designs"
method: POST
path: "/api/v1/research/study-designs/start"
tags: ["research"]
deprecated: true
---

# Start study designs

`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`)

> **Deprecated.**

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.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- ResearchStudyDesignsStartRequest
  - `playbookKey` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap', required: Always `custom`: only a custom study is designed.
  - `profileId` string, uuid, required: The business profile the study is designed for.
  - `questions` ResearchItem3[], required: The draft's questions as they stand.
    - union
      - object
        - `id` string, required
        - `title` string, required
        - `prompt` string, required
        - `flow` union
          - object
            - `kind` 'goto', required
            - `target` union, required
              - …
          - object
            - `kind` 'branch', required
            - `rules` object[], required
              - …
            - `otherwise` union, required
              - …
        - `attachment` object
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
        - `stimulusItemId` string
        - `blind` true
        - `shape` 'open_ended', required
      - object
        - `id` string, required
        - `title` string, required
        - `prompt` string, required
        - `flow` union
          - object
            - `kind` 'goto', required
            - `target` union, required
              - …
          - object
            - `kind` 'branch', required
            - `rules` object[], required
              - …
            - `otherwise` union, required
              - …
        - `attachment` object
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
        - `stimulusItemId` string
        - `blind` true
        - `shape` 'closed_ended' | 'multi_select' | 'rank' | 'matrix' | 'scale', required
        - `options` string[], required
        - `maxSelections` integer
        - `unaided` true
      - object
        - `id` string, required
        - `title` string, required
        - `prompt` string, required
        - `flow` union
          - object
            - `kind` 'goto', required
            - `target` union, required
              - …
          - object
            - `kind` 'branch', required
            - `rules` object[], required
              - …
            - `otherwise` union, required
              - …
        - `attachment` object
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
        - `stimulusItemId` string
        - `blind` true
        - `shape` 'computer_task', required
        - `targets` union[], required
          - union
            - object
              - …
            - object
              - …
        - `successCriteria` string, required
  - `material` union, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'copy', required
      - `copies` object[], required
        - `id` string, required
        - `label` string
        - `body` string, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'ads', required
      - `format` 'full_ad' | 'headline' | 'tagline' | 'product_name' | 'email_subject' | 'social_post'
      - `placement` string
      - `ads` object[], required
        - `id` string, required
        - `headline` string, required
        - `body` string
        - `callToAction` string
        - `landingUrl` string
        - `intendedTakeaway` string
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'concept', required
      - `concepts` object[], required
        - `id` string, required
        - `title` string, required
        - `description` string, required
        - `assetRefs` string[]
        - `prototypeUrl` string
        - `buyerGoal` string
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'offer_set', required
      - `offers` object[], required
        - `id` string, required
        - `title` string, required
        - `description` string, required
        - `terms` string
      - `category` string
      - `liveOffer` object
        - `offerId` string, required
        - `url` string, required
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string, required
      - `kind` 'price_ladder', required
      - `description` string
      - `currency` string, required
      - `billingUnit` 'one_time' | 'per_month' | 'per_year' | 'per_seat_per_month'
      - `prices` object[], required
        - `id` string, required
        - `amount` string, required
        - `label` string
      - `plannedPriceId` string
      - `category` string
      - `alternatives` object[]
        - `id` string, required
        - `name` string, required
        - `amount` string, required
      - `plans` object[]
        - `id` string, required
        - `name` string, required
      - `pricingPageUrl` string
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string, required
      - `kind` 'task', required
      - `instructions` string, required
      - `destinationUrl` string
      - `problem` string
      - `keyMessage` string
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'custom', required
      - `content` string, required
      - `assetRefs` string[]
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'brand', required
      - `brand` string
      - `category` string, required
      - `competitors` string[], required
      - `startUrl` string
    - object
      - `version` 'research-stimulus.v1', required
      - `title` string
      - `kind` 'features', required
      - `job` string, required
      - `productName` string
      - `features` object[], required
        - `id` string, required
        - `name` string, required
        - `description` string, required
      - `productTask` object
        - `startUrl` string, required
        - `successCriteria` string, required
      - `files` object[]
        - `slot` string, required
        - `itemId` string
        - `attachment` object, required
          - `artifactId` string, required
          - `filename` string, required
          - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
          - `byteLength` integer, required
  - `design` ResearchRequestDesign2, required
    - `kind` 'backtest': backtest when the study re-asks a decision the business already made, as its people faced it then. Omit it for any other study.
    - `conversation` object, required
      - `messages` object[], required
        - `role` 'user' | 'assistant', required
        - `content` string, required
      - `attachments` object[], required
        - `artifactId` string, required
        - `filename` string, required
        - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
        - `byteLength` integer, required
    - `name` string, required
    - `goal` string, required
    - `summary` string
    - `questions` ResearchItem3[], required
      - union
        - object
          - `id` string, required
          - `title` string, required
          - `prompt` string, required
          - `flow` union
            - object
              - …
            - object
              - …
          - `attachment` object
            - `artifactId` string, required
            - `filename` string, required
            - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
            - `byteLength` integer, required
          - `stimulusItemId` string
          - `blind` true
          - `shape` 'open_ended', required
        - object
          - `id` string, required
          - `title` string, required
          - `prompt` string, required
          - `flow` union
            - object
              - …
            - object
              - …
          - `attachment` object
            - `artifactId` string, required
            - `filename` string, required
            - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
            - `byteLength` integer, required
          - `stimulusItemId` string
          - `blind` true
          - `shape` 'closed_ended' | 'multi_select' | 'rank' | 'matrix' | 'scale', required
          - `options` string[], required
          - `maxSelections` integer
          - `unaided` true
        - object
          - `id` string, required
          - `title` string, required
          - `prompt` string, required
          - `flow` union
            - object
              - …
            - object
              - …
          - `attachment` object
            - `artifactId` string, required
            - `filename` string, required
            - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
            - `byteLength` integer, required
          - `stimulusItemId` string
          - `blind` true
          - `shape` 'computer_task', required
          - `targets` union[], required
            - union
              - …
          - `successCriteria` string, required
    - `assumptions` string[]: Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none.
    - `decision` object: For a backtest only: its current decision question and what each option keeps. Omit it when there is none.
      - `questionId` string, required: The single-choice question that asks the decision.
      - `keeps` number[], required: By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out.
    - `authorEditedQuestions` object[]: The questions in `questions` the author wrote or edited by hand since Alpha last delivered a study, which Alpha keeps as written unless the latest message asks to change them. Omit it when there are none.
      - `id` string, required: The question's ID in `questions`.
      - `title` string, required: The question's title as the author left it.
      - `prompt` string, required: The question's wording as the author left it.

## Response `202`

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

- ResearchStudyDesignsStartResponse
  - `runId` string, uuid, required: The billing run that pays for the design in Alpha credits.
  - `status` 'pending' | 'ready', required
  - `design` ResearchDesign4, required
    - `message` string, required
    - `study` object, nullable, required
      - `name` string, required
      - `goal` string, required
      - `summary` string, required
      - `questions` ResearchItem3[], required
        - union
          - object
            - `id` string, required
            - `title` string, required
            - `prompt` string, required
            - `flow` union
              - …
            - `attachment` object
              - …
            - `stimulusItemId` string
            - `blind` true
            - `shape` 'open_ended', required
          - object
            - `id` string, required
            - `title` string, required
            - `prompt` string, required
            - `flow` union
              - …
            - `attachment` object
              - …
            - `stimulusItemId` string
            - `blind` true
            - `shape` 'closed_ended' | 'multi_select' | 'rank' | 'matrix' | 'scale', required
            - `options` string[], required
            - `maxSelections` integer
            - `unaided` true
          - object
            - `id` string, required
            - `title` string, required
            - `prompt` string, required
            - `flow` union
              - …
            - `attachment` object
              - …
            - `stimulusItemId` string
            - `blind` true
            - `shape` 'computer_task', required
            - `targets` union[], required
              - …
            - `successCriteria` string, required
      - `assumptions` string[]: Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none.
      - `decision` object: For a backtest only: the single-choice question that asks the decision and what each of its options keeps. Omit it for any other study.
        - `questionId` string, required: The single-choice question that asks the decision.
        - `keeps` number[], required: By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out.

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/5241805fe425?raw)
