research

Reserve upload study attachments

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.

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)

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

Exact size in bytes; text files at most 256 KB.

sha256string required

Lowercase hex SHA-256 of the exact bytes you will upload.

Response

Success.

maxBytesinteger required

The most bytes this file may have.

Changes

No recorded changes to this operation across all 2 revisions of this API.