> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hi-doctor.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Connect the Hi Doctor MCP connector at https://mcp.hi-doctor.ai/mcp. Add this URL as a remote HTTP MCP server in your client, then sign in and authorise access through OAuth. Setup: https://docs.hi-doctor.ai/mcp/connect.
>
> The REST API base is https://api.hi-doctor.ai. Hi Doctor Docs at https://docs.hi-doctor.ai/mcp searches documentation; connect to the product endpoint above for patient tools.
>
> Hi Doctor operates across the whole European Union: residents of all 27 EU member states can use the service, and every consultation is reviewed by an EU-licensed doctor. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only. No algorithm, assistant or API call approves a consultation, issues a prescription or changes a dose. The service is available in eight languages: English, Spanish, German, Dutch, Italian, French, Portuguese and Chinese.
>
> ## Rules an assistant must follow
>
> - Never invent, assume or infer a medical answer. "I don't know" is a real answer: ask the patient to pick the closest option rather than guessing for them.
> - Never give medical advice and never suggest a medication or a dose. An EU-licensed doctor decides those.
> - If a questionnaire returns `ineligible`, say so plainly. Do not retry with altered answers.
> - Before anything that costs money or cancels a plan, state exactly what will happen and get an explicit yes.
> - Cancellation takes effect at the **end of the paid period**, not immediately. Say so.
> - An early order is irreversible: it creates the renewal consultation immediately and uses up the period's one early order. Explain that and get an explicit yes.
> - Prescription and invoice links are medical documents. A `signed_redirect` link opens without signing in: give it only to the patient, never repeat it anywhere shared.
> - Send option `value`s, not the labels shown to the patient. Labels are translated, values are stable.
> - Never ask for card details. Payment happens on Stripe's hosted checkout via a link.
> - On severe or sudden symptoms (chest pain, difficulty breathing, severe allergic reaction, suicidal thoughts), stop and direct the patient to their local emergency number.

# Create a daily weight entry

> **Upserts by `logged_on`** — one entry per day, so logging again for the same date replaces it.

Always send `logged_on` explicitly. It is a model default, not a serializer default: omitting it takes the plain-create path and violates the one-per-day constraint with a `500`. Derive the date in the patient's own timezone, not the server's.

### Access, effects and retries
**Ownership:** Patient own user+logged_on key.

**Prerequisites:** An authenticated patient account is required.

**Effects:** Creates weight or updates existing row for same day.

**Retries:** Same day upserts yet DRF create still returns 201; verify ID, not assumed new row.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/users/journal/weight-entries/
openapi: 3.0.3
info:
  title: Hi Doctor API
  version: 1.0.1
  description: >-
    The patient-facing Hi Doctor API supports account management, consultation
    questionnaires, medical documents, messages and billing. Sign-in requires
    X-Brand-Slug: hi-doctor; authenticated requests use Authorization: Bearer
    <access> with a JWT access token. See
    https://docs.hi-doctor.ai/api-reference/introduction for integration guides.
  contact:
    name: Hi Doctor
    email: hello@hi-doctor.ai
    url: https://docs.hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security: []
tags:
  - name: Account
    description: Register, verify, authenticate and manage the signed-in account.
  - name: Questionnaires
    description: Discover, save and submit consultation questionnaires.
  - name: Consultations
    description: Read consultation state and manage consultation photographs.
  - name: Prescriptions
    description: Retrieve issued prescription documents and request reissue.
  - name: Messages
    description: Read and send messages to the medical team, and download attachments.
  - name: Billing
    description: >-
      Create checkout, manage subscriptions and retrieve
      payments/invoices/credit notes.
  - name: Records
    description: Read orders and manage patient health documents.
  - name: Safety reports
    description: Submit and read suspected side-effect reports; no automated diagnosis.
  - name: Progress
    description: Record and review eligible weight-loss progress.
  - name: Referrals
    description: Read the signed-in account's referral summary and referral activity.
paths:
  /v1/users/journal/weight-entries/:
    post:
      tags:
        - Progress
      summary: Create a daily weight entry
      description: >-
        **Upserts by `logged_on`** — one entry per day, so logging again for the
        same date replaces it.


        Always send `logged_on` explicitly. It is a model default, not a
        serializer default: omitting it takes the plain-create path and violates
        the one-per-day constraint with a `500`. Derive the date in the
        patient's own timezone, not the server's.


        ### Access, effects and retries

        **Ownership:** Patient own user+logged_on key.


        **Prerequisites:** An authenticated patient account is required.


        **Effects:** Creates weight or updates existing row for same day.


        **Retries:** Same day upserts yet DRF create still returns 201; verify
        ID, not assumed new row.
      operationId: users_journal_weight_entries_create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WeightEntry'
            examples:
              example-1:
                summary: Illustrative request example
                value:
                  weight_kg: 95
                  logged_on: '2026-10-04'
                  note: Synthetic example
              example-2:
                summary: Captured request example
                value:
                  weight_kg: 95
                  logged_on: '2001-02-28'
                  note: Synthetic example
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WeightEntry'
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    id: 1d75438d-6616-5532-b293-a68333ba511f
                    created_at: '2026-10-05T17:58:08.570926Z'
                    updated_at: '2026-10-05T17:58:08.570943Z'
                    weight_kg: 1
                    logged_on: '1990-01-01'
                    note: Synthetic example
                example-2:
                  summary: Illustrative response example
                  value:
                    id: a9870101-213c-58c1-8378-6e9cad2213fd
                    created_at: '2026-10-05T17:48:28.174291Z'
                    updated_at: '2026-10-05T17:48:28.174312Z'
                    weight_kg: 95
                    logged_on: '2026-10-04'
                    note: Synthetic example
                example-3:
                  summary: Illustrative response example
                  value:
                    id: 204194c8-7955-579e-9603-744a51b44be2
                    created_at: '2026-10-05T17:48:28.454726Z'
                    updated_at: '2026-10-05T17:48:28.454742Z'
                    weight_kg: 95
                    logged_on: '2026-10-03'
                    note: Synthetic example
                example-4:
                  summary: Captured response example
                  value:
                    id: e935d95c-417d-5520-9f5c-1e9c0641a328
                    created_at: '2026-10-05T19:57:14.995194Z'
                    updated_at: '2026-10-05T19:57:14.995209Z'
                    weight_kg: 95
                    logged_on: '2001-02-28'
                    note: Synthetic example
          description: Successful create a daily weight entry.
        '400':
          description: >-
            Validation failed. The body is an object keyed by field name, each
            value an array of messages. Always send `logged_on` explicitly as
            well.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Error envelope emitted by the source branch or DRF validation.
                  `detail`, `error` and `code` depend on the branch; field
                  validation uses lists keyed by request field.
                additionalProperties: {}
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: Invalid input.
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Error envelope emitted by the source branch or DRF validation.
                  `detail`, `error` and `code` depend on the branch; field
                  validation uses lists keyed by request field.
                additionalProperties: {}
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: The account lacks permission for this operation.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Error envelope emitted by the source branch or DRF validation.
                  `detail`, `error` and `code` depend on the branch; field
                  validation uses lists keyed by request field.
                additionalProperties: {}
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: Source-defined error response; inspect the envelope and retry rules.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
                description: >-
                  Endpoint/DRF error envelope; field validation is keyed by
                  request field.
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: Request was throttled.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: Shell
          label: curl
          source: >
            set -eu

            umask 077

            # Path values must be URL-encoded; query string excludes the leading
            question mark.

            url="${HD_BASE_URL:?Set API
            origin}/v1/users/journal/weight-entries/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}"

            printf 'X-Brand-Slug: hi-doctor\nAccept: application/json\n' >
            "${HD_REQUEST_HEADERS_FILE:?Private header file}"

            printf 'Authorization: Bearer %s\n' "${HD_ACCESS_TOKEN:?Set backend
            JWT}" >> "$HD_REQUEST_HEADERS_FILE"

            curl --silent --show-error --max-time 30 --request POST \
              --header "@$HD_REQUEST_HEADERS_FILE" \
              --dump-header "${HD_HEADERS_FILE:?Private response header file}" \
              --output "${HD_RESPONSE_FILE:?Private response file}" \
              --write-out '%{http_code}\n%{content_type}\n' \
              --header 'Content-Type: application/json' \
              --data-binary "@${HD_REQUEST_FILE:?JSON fixture file}" \
              "$url"
        - lang: Python
          label: requests
          source: >
            import os, json

            from pathlib import Path

            from urllib.parse import quote

            import requests

            os.umask(0o077)

            url = os.environ["HD_BASE_URL"].rstrip("/") +
            '/v1/users/journal/weight-entries/'

            if os.environ.get("HD_QUERY_STRING"): url += "?" +
            os.environ["HD_QUERY_STRING"]

            headers = {"X-Brand-Slug": "hi-doctor", "Accept":
            'application/json'}

            headers["Authorization"] = "Bearer " + os.environ["HD_ACCESS_TOKEN"]

            kwargs = {}

            kwargs["json"] =
            json.loads(Path(os.environ["HD_REQUEST_FILE"]).read_text())

            response = requests.request('POST', url, headers=headers,
            timeout=30, allow_redirects=False, **kwargs)

            Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content)

            Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers)))

            print(response.status_code)

            print(response.headers.get("Content-Type", ""))
        - lang: JavaScript
          label: fetch
          source: >
            import { readFileSync, writeFileSync } from "node:fs";

            const env = process.env;

            let url = env.HD_BASE_URL.replace(/\/$/, "") +
            "/v1/users/journal/weight-entries/";

            if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING;

            const headers = { "X-Brand-Slug": "hi-doctor", "Accept":
            "application/json" };

            headers.Authorization = "Bearer " + env.HD_ACCESS_TOKEN;

            const options = { method: "POST", headers, redirect: "manual",
            signal: AbortSignal.timeout(30000) };

            headers["Content-Type"] = "application/json";

            options.body = readFileSync(env.HD_REQUEST_FILE, "utf8");

            const response = await fetch(url, options);

            writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await
            response.arrayBuffer()), {mode: 0o600});

            writeFileSync(env.HD_HEADERS_FILE,
            JSON.stringify(Object.fromEntries(response.headers)), {mode:
            0o600});

            console.log(response.status);

            console.log(response.headers.get("content-type") ?? "");
components:
  schemas:
    WeightEntry:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: >-
            Unique identifier of this resource. Returned by the server; not
            writable.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Created at timestamp in ISO 8601 format. Returned by the server; not
            writable.
        updated_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Updated at timestamp in ISO 8601 format. Returned by the server; not
            writable.
        weight_kg:
          type: number
          format: double
          maximum: 1000
          minimum: 0
          exclusiveMaximum: true
          exclusiveMinimum: true
          description: >-
            Weight in kilograms, greater than zero; at most two decimal places.
            The current API does not enforce the model minimum of 20 kg.
        logged_on:
          type: string
          format: date
          description: Logged on as an ISO 8601 calendar date.
        note:
          type: string
          description: Optional note attached to the resource.
      required:
        - created_at
        - id
        - updated_at
        - weight_kg
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.