research

Reserve study attachment sources

Reserve the upload of a file Point11 converts into a study file: a picture a study cannot read as it is (GIF, HEIC or HEIF, AVIF, TIFF, BMP or SVG, or a JPEG, PNG or WebP past what reserve-upload admits), any video (MOV, M4V, MKV, AVI, MPEG, 3GP or WMV, or an MP4 or WebM of any codec), a sound (M4A or AAC, OGG or Opus, FLAC, AIFF, WebM audio or WMA, or MP3 or WAV past 4 MiB) or a document (PowerPoint, Keynote, Word, OpenDocument or RTF, or a PDF past 4 MiB). Declare its filename, media type and size: a picture at most 50 MiB, a video 500 MiB, a sound 200 MiB, a document 100 MiB. Its type is the one its name's extension names, else its declared type. Upload the exact bytes using the returned presigned request, then call research_study_attachment_sources_convert. Reuse the same Idempotency-Key and input after a lost response.

post/api/v1/research/study-attachment-sources/reserve

Request

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

mediaTypestring required

The type the file's sender names it by; its name's extension comes first.

byteLengthinteger required

Exact size in bytes: a picture at most 50 MiB, a video 500 MiB, a sound 200 MiB, a document 100 MiB.

Response

Success.

Changes

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