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

X-Brand-Slug
enum<string>
default:hi-doctor

Send X-Brand-Slug: hi-doctor. Public auth/questionnaire/attribution routes resolve the brand header; authenticated scope also uses the live user brand. Do not claim the header is universally server-required: default-brand fallback exists.

Available options:
hi-doctor
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

multipart/form-data
image
file
required

Image bytes uploaded for the owned consultation.

Response

Authorized consultation image metadata.

id
string<uuid>
required

Image identifier.

url
string<uri>
required

Authorized image content URL.

filename
string
required

Display filename.

uploaded_at
string<date-time>
required

Upload timestamp.

consultation_id
string<uuid>
required

Owning consultation identifier.

available
boolean
required

Whether this image remains available.

source
string

Present for an image originally supplied through the questionnaire.

question_key
string | null

Question key for a questionnaire image; null if unavailable.