Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional key that makes a retry safe. Generate one value per logical operation (8 to 128 ASCII letters, digits, underscores or hyphens) and resend the same value on every retry. A repeat of a completed request returns its original status with Idempotent-Replayed: true and a short body of state, resource_ids and response_hash; read the resources to recover their content. Reusing a key with a different request returns 422 idempotency_key_reuse; a request still running returns 409 idempotency_in_progress. Keys are kept for 30 days. See https://docs.hi-doctor.ai/api-reference/idempotency.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Path Parameters

id
string<uuid>
required

Identifier returned by the corresponding authorized collection; use only a record visible to the signed-in patient.

Body

application/json
content
string
required

Message text sent to the conversation participants.

Response

Successful send a message.

A single message in the patient's thread with the medical team.

id
string<uuid>

Unique identifier of this resource.

sender
string<uuid>

Account id of the sender.

sender_type
enum<string>

Sender class, including automatic system messages; visibility is filtered to the caller.

Available options:
USER,
ADMIN,
DOCTOR,
SYSTEM
content
string | null

Text content of the resource. May be null when unavailable.

file
string<uri> | null

File for this conversation message. May be null when unavailable.

is_read
boolean

Whether read applies to this conversation message.

created_at
string<date-time>

Created at timestamp in ISO 8601 format.

translation_enabled
boolean

Whether translation enabled applies to this conversation message.

translation_default_on
boolean

Whether translation default on applies to this conversation message.

source_text
string | null

Original message text, emitted only to internal actors.

file_name
string | null

Display name of the attached file, or null.

file_content_type
string | null

Attachment media type, or null.

event_type
string | null

Machine event identifier, or null for an ordinary message.

file_available
boolean

Whether the authorized attachment remains available.

audience
enum<string>

Message audience. Patient requests return only patient-visible messages.

Available options:
patient,
staff
event_params
any

Structured JSON event parameters; null for an ordinary message.

translation
object

Cached translation, present only when available.