LogMeal Dysphagia User Feedback API

openapi: 3.2.0
info:
  version: 2.1.0
  title: Food AI Engine API Documentation Dysphagia User Feedback API
  description: Please, refer to https://docs.logmeal.com to find the most up-to-date version of the Food AI Engine API documentation.
  contact:
    email: support@logmeal.com
servers:
- url: https://api.logmeal.com
  description: Production
tags:
- name: Dysphagia User Feedback
  description: 'Allows users to provide feedback about food stickiness and swallowing ease.

    ⚡ Custom plans only ⚡'
  externalDocs:
    url: https://docs.logmeal.com/docs/guides-features-user-feedback-dysphagia#/
paths:
  /v2/dysphagia/options:
    get:
      tags:
      - Dysphagia User Feedback
      summary: 🔴 Get different Dysphagia measurement options
      description: 'This endpoint returns the information and explanation about the Dysphagia measurement options.


        The options are ''Adhesiveness'' and ''Swallowing'' followed by its numerical value (on a scale from 1 to 5) specifying the difficulty on the intake, where 1 would be the easiest level on the scale

        and 5 the hardest one.'
      responses:
        '200':
          description: Token is valid. Measurements information is sent in response (JSON format)
          content:
            application/json:
              schema:
                type: object
                properties:
                  adhesiveness:
                    description: 'Numerical value referring to the adhesiveness of the intake where 1 would be the lowest level and 5 the highest one.


                      1: "NOT_ADHESIVE",


                      2: "SLIGHTLY_ADHESIVE",


                      3: "NORMAL",


                      4: "MODERATELY_ADHESIVE",


                      5: "VERY_ADHESIVE"

                      '
                    type: object
                  swallowing:
                    description: 'Numerical value referring to the swallowing difficulty of the intake where 1 would be the easiest level and 5 the hardest one.


                      1: "EASY",


                      2: "FAIRLY_EASY",


                      3: "NORMAL",


                      4: "SLIGHTLY_DIFFICULT",


                      5: "DIFFICULT"

                      '
                    type: object
        '400':
          description: Bad request.
        '401':
          description: Unauthorized, invalid token
        '403':
          description: You are not allowed to this method.
        '404':
          description: The specified URL was not found or couldn’t be retrieved
        '429':
          description: Too Many Requests. (limited per daily calls per user or overall calls per second)
      security:
      - Bearer: []
      operationId: getV2DysphagiaOptions
      x-operation-id-source: derived
  /v2/dysphagia/{imageId}:
    post:
      tags:
      - Dysphagia User Feedback
      summary: 🔴 Stores Dysphagia measurement values for the given imageId
      description: 'This endpoint stores information about Dysphagia measurement option values for the given imageId.

        The measurement types, ''adhesiveness'' and ''swallowing'', can be passed individually or together via the request''s body, but at least one must be included.


        If the body is passed with an empty JSON, the previously stored measures will be deleted. A measure type can be provided empty or null to delete that specific type.'
      parameters:
      - in: path
        name: imageId
        schema:
          type: integer
        example: 175592
        required: true
        description: ID of the image.
      requestBody:
        description: 'Dysphagia measures from the intake.

          The keys of the body have to be one of the measurement type names (''adhesiveness'' or ''swallowing'').

          And the keys of each measurement has to be the food_item_position of the image and the value has to be a number between 1 and 5.


          If the body is passed with an empty JSON, the previously stored measures will be deleted. A measure type can be provided empty or null to delete that specific type.

          '
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                adhesiveness:
                  description: "JSON where key value will be the food item position on the image and its value will be a number referring to the adhesiveness of the intake where 1 would be the lowest level and 5 the highest one.\n            \n\"1\": 4,\n\n\"2\": 1,\n\n\"3\": 4\n"
                  type: object
                  properties:
                    food_item_position_1:
                      example: 4
                      type: integer
                    food_item_position_2:
                      example: 1
                      type: integer
                    food_item_position_3:
                      example: 4
                      type: integer
                swallowing:
                  description: 'JSON where key value will be the food item position on the image and its value will be a number referring to the swallowing difficulty of the intake where 1 would be the easiest level and 5 the hardest one.


                    "1": 3,


                    "2": 3,


                    "3": 5

                    '
                  type: object
                  properties:
                    food_item_position_1:
                      example: 3
                      type: integer
                    food_item_position_2:
                      example: 3
                      type: integer
                    food_item_position_3:
                      example: 5
                      type: integer
      responses:
        '200':
          description: 'Token is valid. Dysphagia measures successfully stored!


            If JSON is empty. Dysphagia measures successfully deleted!

            '
        '400':
          description: Bad request.
        '401':
          description: Unauthorized, invalid token
        '403':
          description: You are not allowed to this method.
        '404':
          description: The specified URL was not found or couldn’t be retrieved
        '429':
          description: Too Many Requests. (limited per daily calls per user or overall calls per second)
      security:
      - Bearer: []
      operationId: postV2DysphagiaByImageId
      x-operation-id-source: derived
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-build:
  time: '2026-10-19T02:02:11.433999Z'
x-provenance:
  method: harvested
  publisher: LogMeal
  source: https://docs.logmeal.com/openapi/logmeal_openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)