research

Download study attachments

Download one ready study attachment by id, or one frame of a video's storyboard by the frame's id: its filename, media type and size, and a short-lived URL that GETs its bytes.

get/api/v1/research/study-attachments/download

Request

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

Query parameters

idstring uuid required

The study attachment id, or a storyboard frame's 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.

filenamestring required

Suggested file name for saving the bytes

contentTypestring required
byteLengthinteger required
urlstring uri nullable required

Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object

expiresAtstring date-time nullable required

When url stops working (minutes after the call); null with url

idstring uuid required

Changes

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