Skip to main content
POST
Create files

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Headers

Idempotency-Key
string

Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.

Maximum string length: 255

Body

multipart/form-data
patient_id
integer
required

The patient the file belongs to.

Required range: x >= 1
file_type
enum<string>
required

The file's category, set at upload and changeable within the app's re-type rules.

Available options:
generic,
patient_profile,
custom_content,
diagnostic_image,
patient_log
file
file
required
description
string | null

Free-text description shown alongside the file.

Maximum string length: 255
patient_viewable
boolean

Whether the patient can see the file in the patient app.

patient_log_id
integer | null

Required when file_type is patient_log.

Required range: x >= 1
metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object
Example: