Create a progress note

post/v1/progress-notes

Creates a progress note and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff and caregivers. With a caregiver's or patient's key, a saved record that key cannot read back is answered with only object and id. Requires a key with write scope.

Authorization

Authorization: Bearer ak_...requiredscope: read + write

An AveeCare API key created in Settings → API Keys. This endpoint changes data, so the key needs read + write scope. About authentication

Headers

Idempotency-Key

stringmax length 255

A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.

Request body

application/json

visitId

stringrequiredmax length 64

The visit the note documents.

patientId

stringrequiredmax length 64

The patient.

caregiverId

string | nullmax length 64

The caregiver who wrote the note. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them.

summary

stringrequiredmax length 20000

The written summary of the visit.

Response

201

The new progress note.

object

stringread-only

String representing the object's type. Always progress_note.

stringread-only

Unique identifier of the progress note.

visitId

string | nullmax length 64

The visit the note documents.

patientId

string | nullmax length 64

The patient.

caregiverId

string | nullmax length 64

The caregiver who wrote the note. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them.

caregiverName

string | nullread-onlymax length 2000

Display name of the caregiver, taken from the caregiver's record.

summary

string | nullmax length 20000

The written summary of the visit.

aiGenerated

boolean | nullread-only

Whether the summary was drafted with AI assistance.

createdAt

string · date-time | nullread-only

When the progress note was created.

updatedAt

string · date-time | nullread-only

When the progress note was last changed.

Response headers

Request-IdstringUnique ID of this request. Quote it when contacting support.

RateLimit-LimitintegerRequests allowed in the current window.

RateLimit-RemainingintegerRequests left in the current window.

RateLimit-ResetintegerSeconds until the window resets.

Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.

Errors

Status	Code	Meaning
400	n/a	The request was malformed, a value was invalid, or it contained an unknown field (`invalid_request`, `unknown_field`).
401	n/a	The API key is missing, malformed, expired or revoked (`unauthorized`).
403	n/a	The key is read-only (`insufficient_scope`), or its user's role cannot do this (`forbidden`).
409	n/a	The `Idempotency-Key` was already used with a different request, or that request is still running (`idempotency_conflict`).
429	n/a	Too many requests (`rate_limited`). Wait for `Retry-After` seconds.
500	n/a	Something went wrong on our side (`internal_error`). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.