research

Get study attachments

Deprecated: use research.study-attachments.get.v2 (research_study_attachments_get_v2) for native audio; this version does not find an audio attachment. Get one ready study attachment by id: its filename, media type and size. A video also answers its storyboard, the timed still frames and transcript a study shows in its place: preparing, ready (with its duration, each frame's time, size and id, the transcript, and the bytes it counts toward a study's 8 MiB of attachments), refused (with the reason the file cannot be used) or failed. A refused or failed video is replaced by uploading it again. Read a frame's picture with research_study_attachments_download by the frame's id.

get/api/v1/research/study-attachments/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-attachments/{id}
  • 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)

Path parameters

idstring uuid required

The study attachment id.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

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' 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.