research

Import connected study attachments

Attach a study file from one of the member's own connected apps instead of uploading it: a file in Google Drive, OneDrive or Dropbox, a Figma frame (it comes in as a PNG at up to twice its size), or a Canva design (a PNG for one page, a PDF for several, or an MP4 when its ref asks for a video). Name the app and the item's ref as alpha_connector_files_list returned it. Point11 reads it with the member's own connection and admits it exactly as an upload, converting a file a study cannot read as it is (a Google document comes in as a PDF). Returns the attachment, ready to reference from a study question; retrying with the same Idempotency-Key answers the same file without reading the app again. Connect the app in Settings, under Connections, first. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed.

post/api/v1/research/study-attachments/import-connected

Request

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

source'google' | 'microsoft' | 'dropbox' | 'figma' | 'canva' required

The connected app: google (Google Drive), microsoft (OneDrive), dropbox, figma or canva.

refstring required

The item's ref, as alpha_connector_files_list returned 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' | '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.