Skip to main content
POST
/
patients
/
{patientId}
/
documents
Upload a document
curl --request POST \
  --url https://api.healos.ai/ext-api/v1/patients/{patientId}/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'file=<unknown>' \
  --form external_id=PARTNER-DOC-456
{
  "data": {
    "id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
    "filename": "intake_form_maria_santos.pdf",
    "file_size": 245760,
    "public_url": "<string>",
    "upload_date": "2026-03-20T11:15:00.000Z",
    "external_id": "PARTNER-DOC-456"
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.healos.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

​
patientId
string
required

Patient ID

Example:

"1743552000000"

Body

multipart/form-data
​
file
any | null

The file to upload

​
external_id
string

Optional caller-supplied identifier. Unique per organization; immutable once set.

Required string length: 1 - 255
Example:

"PARTNER-DOC-456"

Response

Document uploaded successfully

​
data
object
required
​
message
string
required