---
title: "Get study designs"
method: GET
path: "/api/v1/research/study-designs/{id}"
tags: ["research"]
deprecated: true
---

# Get study designs

`GET /api/v1/research/study-designs/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/study-designs/{id}`
- 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.get.v2 (research_study_designs_get_v2), which also names a question's video; this version leaves a video out, so a question that shows one reads as showing no file. Get a Research study design the signed-in user started, by the Idempotency-Key of its research.study-designs.start request: pending, failed, or ready with Alpha's reply and the study. Reading makes no model call. A key that started no design of yours is not found.

## Path parameters

- `id` string, uuid, required: The Idempotency-Key of the research.study-designs.start request.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ResearchStudyDesignsGetResponse
  - `runId` string, uuid, required: The billing run that pays for the design in Alpha credits.
  - `status` 'pending' | 'failed' | '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.
  - `failureDisposition` 'transient' | 'repairable_schema' | 'deterministic' | 'cancelled' | 'unknown' | 'repairable_domain': Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `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/36a84c7aca11?raw)