RXrxfoodapp
food

Search foods by photo with FFE algorithm applied and results put in a queue for backend review

Changed on
post/foods/search_by_photo_ffe_queue

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/foods/search_by_photo_ffe_queue
  • Auth
    HTTP bearer

Request body multipart/form-data

capture_channel'photo' | 'barcode' | 'label' | 'describe' | 'copy' | 'manual' | 'custom_food'
cpg_metadatastring nullable

JSON string representation of CreateMealItemRequest

meal_datestring

calendar date in format YYYY-MM-DD

meal_name'breakfast' | 'lunch' | 'dinner' | 'snack'
meal_timestring

time in format hh:mm:ss

notestring
num_itemsinteger nullable
photostring binary
photo2string binary
photo_idstring
photo_timings_encodedstring
photo_urlsstring[]
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
queue_metadatastring nullable
sizing_input'small' | 'medium' | 'large' | 'x-large' nullable

Example request

{
  "meal_date": "2021-04-02",
  "meal_time": "17:30:00"
}

Response

successful operation

created_by_user_idinteger nullable
idinteger required
is_deletedboolean
last_updated_by_user_idinteger nullable
meal_datestring required

calendar date in format YYYY-MM-DD

meal_name'breakfast' | 'lunch' | 'dinner' | 'snack' required
meal_name_translationsobject nullable
meal_photo_idinteger nullable
meal_photo_original_urlstring nullable
meal_photo_resized_urlstring nullable
meal_timestring required

time in format hh:mm:ss

patient_idinteger required

Example response

{
  "meal_date": "2019-01-02",
  "meal_items": [
    {
      "custom_addons": [
        {
          "nutrient_overrides": {
            "aa_patient": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "bb_reviewer": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "cc_external": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "dd_estimate": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "ee_validation": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            }
          },
          "serving_unit_amount": 1,
          "serving_unit_label": "gram"
        }
      ],
      "nutrient_overrides": {
        "aa_patient": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "bb_reviewer": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "cc_external": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "dd_estimate": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "ee_validation": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        }
      }
    }
  ],
  "meal_time": "17:30:00"
}

Changes

  • 8235bb81b47eRevision changes
    • info

      added the new optional request property

  • 7d063ed4f8caRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status