Skip to main content
POST
/
patients
Create a new patient
curl --request POST \
  --url https://api.healos.ai/ext-api/v1/patients \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Maria Santos",
  "external_id": "PARTNER-12345"
}
'
{
  "data": {
    "id": "481926357104938271",
    "name": "Maria Santos",
    "created_at": "2026-03-15T09:30:00.000Z",
    "pronouns": "she/her",
    "notes": "History of generalized anxiety disorder. Currently on sertraline 50mg.",
    "consent": true,
    "external_id": "PARTNER-12345"
  }
}

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

Body

application/json
​
name
string
required

Patient name (required)

Minimum string length: 1
Example:

"Maria Santos"

​
external_id
string

Optional caller-supplied identifier. Unique per organization; immutable once set. Duplicate values return 409 with the existing record.

Required string length: 1 - 255
Example:

"PARTNER-12345"

Response

Patient created

​
data
object
required