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

# Reserve upload study attachments (v3)

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

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/study-attachments/reserve-upload-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`)

> **Deprecated.**

Deprecated: use research.study-attachments.reserve-upload.v4 (research_study_attachments_reserve_upload_v4), which bounds a picture to the 3,750,000 bytes one picture carries to a model; this version admits a picture up to 4 MiB. Supports original MP3 and WAV audio alongside the existing study media. Reserve an organization-owned Research attachment as a member or organization API key. Declare its filename, media type and size, plus SHA-256 for images, PDFs, text, MP3 and WAV; MP4 or WebM videos declare no digest. Upload the exact bytes using the returned presigned request, then call research_study_attachments_complete_upload_v3. The attachment records the member or API key that reserved it. Reuse the same Idempotency-Key and input after a lost response; a different caller cannot adopt the reservation.

## Headers

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

## Request body

- ResearchStudyAttachmentsReserveUploadV3Request
  - `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' | 'video/mp4' | 'video/webm' | 'audio/mpeg' | 'audio/wav', required
  - `byteLength` integer, required: Exact size in bytes: an image or a PDF at most 4 MiB, a text file at most 256 KB, a video at most 100 MiB.
  - `sha256` string: Lowercase hex SHA-256 of the exact bytes you will upload. Required for every file but a video, which declares none.

## Response `200`

Success.

- ResearchStudyAttachmentsReserveUploadV3Response
  - `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' | 'video/mp4' | 'video/webm' | 'audio/mpeg' | 'audio/wav', required
    - `byteLength` integer, required
    - `status` 'pending' | 'ready', required: pending until research.study-attachments.complete-upload.v2 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.v2.
    - `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)