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}$

Body

application/json
{key}
any

Response

Successful create a medical-team conversation.

id
string<uuid>
required
read-only

Unique identifier of this resource. Returned by the server; not writable.

user
object
required

User for this conversation. Returned by the server; not writable.

created_at
string<date-time>
required
read-only

Created at timestamp in ISO 8601 format. Returned by the server; not writable.

updated_at
string<date-time>
required
read-only

Updated at timestamp in ISO 8601 format. Returned by the server; not writable.

last_message
required

The most recent message. Null when the thread is empty.

last_message_created_at
string<date-time> | null
required
read-only

Last message created at timestamp in ISO 8601 format. Returned by the server; not writable. May be null when unavailable.

last_message_sender_type
enum<string> | null
required
read-only

Last message sender type for this conversation. Returned by the server; not writable. May be null when unavailable.

Available options:
USER,
ADMIN,
DOCTOR,
SYSTEM,
null
unread_count
integer
required
read-only

Unread count for this conversation. Returned by the server; not writable.

subscription_status
string | null
required
read-only

Subscription status for this conversation. Returned by the server; not writable. May be null when unavailable.

is_active
boolean

Whether active applies to this conversation.

pinned_at
string<date-time> | null

Pinned at timestamp in ISO 8601 format. May be null when unavailable.

translation_target_lang
string | null
read-only

Translation target lang for this conversation. Returned by the server; not writable. May be null when unavailable.