research

Reserve upload study attachments (v2)

Deprecated: use research.study-attachments.reserve-upload.v3 (research_study_attachments_reserve_upload_v3) for native audio; this version takes no audio. Reserve a file to attach to a Research study question, declaring its name, media type and size: a PNG, JPEG, WebP or PDF up to 4 MiB or a plain text, Markdown or CSV file up to 256 KB, each with its SHA-256, or an MP4 or WebM video up to 100 MiB, which declares no 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_v2. Attachments record the member who uploaded them, so an API key cannot reserve one.

post/api/v1/research/study-attachments/reserve-upload-v2

Request

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

filenamestring 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' required
byteLengthinteger 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.

sha256string

Lowercase hex SHA-256 of the exact bytes you will upload. Required for every file but a video, which declares none.

Response

Success.

maxBytesinteger required

The most bytes this file may have.

Changes

No recorded changes to this operation across all 1 revision of this API.