research

Convert study attachment sources

Convert an uploaded original into the study file it becomes, and attach it: a still picture becomes a JPEG (a WebP when it has transparency) within 2,048 pixels and 3.75 MB, a moving picture or a video an H.264 MP4 a browser plays (copied as it stands when it already is one) of at most 3 minutes and 100 MiB, a sound an MP3 within 4 MiB, and slides or a document a PDF within 4 MiB. The study keeps only the converted file, named as the original with its new extension; the original is deleted. Returns the attachment, ready to reference from a study question; retrying with the same Idempotency-Key answers the same file without converting again. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed. A file Point11 cannot read, or one that cannot fit a study once converted, is refused with its reason.

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

Request

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

idstring uuid required

The source id reserve returned.

filenamestring required

The original's name; the study file keeps it with its new extension.

Response

Success.

idstring uuid required
filenamestring required
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
status'pending' | 'ready' required

pending until research.study-attachments.complete-upload.v2 proves the upload.

Changes

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