Skip to main content
POST
Upload a Study asset

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Path Parameters

studyId
string<uuid>
required

Body

multipart/form-data

Multipart body for uploading a Study asset. file is the PDF or image.

purpose
enum<string>
required

CONSENT_DOCUMENT accepts one application/pdf. QUESTION_IMAGE accepts one image/gif, image/jpeg, image/png, or image/webp file. image/jpg is not accepted.

Available options:
CONSENT_DOCUMENT,
QUESTION_IMAGE
file
string
required

File bytes. Maximum size is 10MB.

Response

Created

An uploaded Study asset. Uploading does not attach it to a Question or change the Study version. width and height are present for QUESTION_IMAGE only.

id
string
required

Opaque id. A Consent / Legal question stores a CONSENT_DOCUMENT id as assetId.

originalFilename
string
required
url
string
required
purpose
enum<string>
required
Available options:
CONSENT_DOCUMENT
mediaType
enum<string>
required
Available options:
application/pdf