research

Complete upload study attachments (v3)

Supports original MP3 and WAV audio alongside the existing study media. Finish a study attachment after its upload: the stored file is read back, must match the reserved size (and the reserved SHA-256, for a file or a text), and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the attachment, ready to reference from a study question; retrying is safe. 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/complete-upload-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-attachments/complete-upload-v3
  • 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 attachment id reserve-upload returned.

etagstring

The etag the upload's response named; omit to recover it from the store.

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.