research

Reserve upload study attachments (v3)

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.

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)

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' | 'audio/mpeg' | 'audio/wav' 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.