---
title: "Reserve upload study attachments"
method: POST
path: "/api/v1/research/study-attachments/reserve-upload"
tags: ["research"]
deprecated: true
---

# Reserve upload study attachments

`POST /api/v1/research/study-attachments/reserve-upload`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/study-attachments/reserve-upload`
- 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-attachments.reserve-upload.v2 (research_study_attachments_reserve_upload_v2), which also reserves a video; this version cannot name one. Reserve a file to attach to a Research study question (PNG, JPEG, WebP, PDF, plain text, Markdown or CSV), declaring its name, media type, size and SHA-256. Returns the attachment and one presigned upload: send the file as the body of exactly that request before it expires, then call research.study-attachments.complete-upload.v1. Attachments record the member who uploaded them, so an API key cannot reserve one.

## Headers

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

## Request body

- ResearchStudyAttachmentsReserveUploadRequest
  - `filename` string, required: The file's name as the editor shows it.
  - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
  - `byteLength` integer, required: Exact size in bytes; text files at most 256 KB.
  - `sha256` string, required: Lowercase hex SHA-256 of the exact bytes you will upload.

## Response `200`

Success.

- ResearchStudyAttachmentsReserveUploadResponse
  - `attachment` object, required
    - `id` string, uuid, required
    - `filename` string, required
    - `mediaType` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf' | 'text/plain' | 'text/markdown' | 'text/csv', required
    - `byteLength` integer, required
    - `status` 'pending' | 'ready', required: pending until research.study-attachments.complete-upload.v1 proves the upload.
  - `upload` object, nullable, required: Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachments.complete-upload.v1.
    - `method` 'PUT', required
    - `url` string, uri, required
    - `headers` object, required
    - `expiresAt` string, date-time, required
  - `maxBytes` integer, required: The most bytes this file may have.

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