research

Reserve upload study attachments (v4)

Bounds a PNG, JPEG or WebP picture to 3,750,000 bytes, the most one picture carries to any model Point11 shows it to; a PDF and MP3 or WAV audio stay at 4 MiB, a plain text, Markdown or CSV file at 256 KB, and an MP4 or WebM video at 100 MiB. Reserve an organization-owned Research attachment as a member or organization API key. Declare its filename, media type and size, plus SHA-256 for every file but a video, which declares none. 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-v4

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-attachments/reserve-upload-v4
  • 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: a PNG, JPEG or WebP picture at most 3,750,000 bytes, a PDF or an MP3 or WAV audio file 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.