Edamam Nutrition Details API

openapi: 3.0.3
info:
  version: '2.0'
  title: Food Database Food Nutrition Request - AI Vision (Beta) Food Nutrition Request - AI Vision (Beta) Nutrition Details API
  description: ''
servers:
- url: https://api.edamam.com
tags:
- name: Nutrition Details
paths:
  /api/nutrition-details:
    post:
      summary: Full Recipe Analysis
      description: 'This returns the nutritional information based on a POST request of the recipe content. The POST request submits

        the recipe content, specifically the recipe title and ingredient list. The response the API returns, will

        contain the nutritional analysis for the recipe based on the information provided.'
      parameters:
      - name: app_id
        in: query
        x-data-threescale-name: app_ids
        description: The application ID, obtained from the dashboard, <https://developer.edamam.com/admin/applications>.
        required: true
        schema:
          type: string
      - name: app_key
        in: query
        x-data-threescale-name: app_keys
        description: The application key, obtained from the dashboard, <https://developer.edamam.com/admin/applications>.
        required: true
        schema:
          type: string
      - name: Edamam-Account-User
        description: ID of the account user. Should be used *only* if the account is configured for active user tracking.
        in: header
        schema:
          type: string
      - name: beta
        in: query
        description: Allow beta features in the request and response
        schema:
          type: boolean
      - name: If-None-Match
        in: header
        description: 'Each successfully processed recipe will also return a tag in the ETag response header. This value must be

          preserved together with the recipe. When resubmitting the recipe, you should include the value in the

          If-None-Match request header and store the updated ETag header.'
        schema:
          type: string
      - name: force
        in: query
        description: Force the re-evaluation of the recipe even when the `If-None-Match` parameter is provided and is valid.
        schema:
          type: boolean
      - name: kitchen
        in: query
        description: 'Select the type of kitchen this recipe is for. If this parameter is not present "home" is assumed as

          default.'
        schema:
          type: string
          enum:
          - home
          - commercial
      - name: Content-Language
        in: header
        description: 'The request language. Using languages other than English may incur translation charges.


          Defaults to `en`.'
        schema:
          enum:
          - ar
          - de
          - en
          - es
          - fr
          - it
          - nl
          - pt
          - ru
          - tr
      - name: field
        in: query
        description: "Recipe fields to be included in the response. If the field is not specified, then we include the\nfollowing fields:\n\n    - uri\n    - url\n    - yield\n    - calories\n    - glycemicIndex\n    - inflammatoryIndex\n    - co2EmissionsClass\n    - totalWeight\n    - dietLabels\n    - healthLabels\n    - cautions\n    - totalNutrients\n    - totalNutrientsKCal\n    - totalDaily\n    - ingredientLines\n    - label\n    - preparation\n    - ingredients\n    - cuisineType\n    - mealType\n    - dishType\n\nThese are all the available fields from before the introduction of this feature.\n\nUse `*` to include all fields, or explicitly specify all the fields that are needed."
        explode: true
        schema:
          type: array
          uniqueItems: true
          items:
            type: string
            enum:
            - '*'
            - uri
            - url
            - yield
            - calories
            - glycemicIndex
            - inflammatoryIndex
            - co2EmissionsClass
            - totalWeight
            - dietLabels
            - healthLabels
            - cautions
            - totalNutrients
            - totalNutrientsKCal
            - totalDaily
            - ingredientLines
            - label
            - preparation
            - ingredients
            - cuisineType
            - mealType
            - dishType
            - translations
      requestBody:
        description: 'Using the food ID and the measure URI which parser provides you can make a request to the nutrients access

          point. The nutrients access points returns nutrition with diet and health labels for a given quantity of the

          food.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Recipe'
      responses:
        '200':
          description: OK - The result of the recipe analysis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzedRecipe'
        '304':
          description: Not Modified.
        '404':
          description: Not Found - The specified URL was not found or couldn't be retrieved
        '406':
          description: None of the requested locales are supported
        '409':
          description: The provided ETag token does not match the input data
        '422':
          description: Unprocessable Entity - Couldn't parse the recipe or extract the nutritional info
        '555':
          description: Recipe with insufficient quality to process correctly
      tags:
      - Nutrition Details
components:
  schemas:
    AnalyzedRecipe:
      type: object
      description: The extracted information. Not all information is available for each recipe or for every plan.
      properties:
        uri:
          type: string
        url:
          type: string
        yield:
          type: number
        calories:
          type: integer
        glycemicIndex:
          type: number
        inflammatoryIndex:
          type: number
        co2EmissionsClass:
          type: string
          enum:
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
        totalWeight:
          type: number
        dietLabels:
          type: array
          items:
            type: string
        healthLabels:
          type: array
          items:
            type: string
        cautions:
          type: array
          items:
            type: string
        totalNutrients:
          $ref: '#/components/schemas/Nutrients'
        totalNutrientsKCal:
          $ref: '#/components/schemas/Nutrients'
        totalDaily:
          $ref: '#/components/schemas/Nutrients'
        ingredientLines:
          type: array
          items:
            type: string
        label:
          type: string
        preparation:
          type: array
          items:
            type: string
        ingredients:
          type: array
          items:
            $ref: '#/components/schemas/Ingredient'
        cuisineType:
          type: array
          items:
            type: string
            enum:
            - american
            - asian
            - british
            - caribbean
            - central europe
            - chinese
            - eastern europe
            - french
            - greek
            - indian
            - italian
            - japanese
            - korean
            - kosher
            - mediterranean
            - mexican
            - middle eastern
            - nordic
            - south american
            - south east asian
            - world
        mealType:
          type: array
          items:
            type: string
            enum:
            - breakfast
            - brunch
            - lunch/dinner
            - snack
            - teatime
        dishType:
          type: array
          items:
            type: string
            enum:
            - alcohol cocktail
            - biscuits and cookies
            - bread
            - casserole
            - cereals
            - condiments and sauces
            - desserts
            - drinks
            - egg
            - ice cream and custard
            - main course
            - pancake
            - pasta
            - pastry
            - pies and tarts
            - pizza
            - preps
            - preserve
            - salad
            - sandwiches
            - seafood
            - side dish
            - soup
            - special occasions
            - starter
            - sweets
        translations:
          type: array
          items:
            $ref: '#/components/schemas/TranslatedLabel'
    Ingredient:
      type: object
      properties:
        text:
          type: string
        parsed:
          $ref: '#/components/schemas/Parsed'
    Quantity:
      type: object
      properties:
        uri:
          type: string
        label:
          type: string
        quantity:
          type: number
    TranslatedLabel:
      type: object
      properties:
        type:
          type: string
          enum:
          - health
          - diet
          - caution
          - cuisineType
          - mealType
          - dishType
        id:
          type: string
        label:
          type: string
      required:
      - type
      - id
      - label
    Parsed:
      type: object
      properties:
        quantity:
          type: number
        measure:
          type: string
        measureURI:
          type: string
        foodMatch:
          type: string
        food:
          type: string
        foodId:
          type: string
        foodURI:
          type: string
        specificFoodURI:
          type: string
        foodCategory:
          type: string
        brand:
          type: string
        foodContentsLabel:
          type: string
        weight:
          type: number
        retainedWeight:
          type: number
        nutrients:
          $ref: '#/components/schemas/Nutrients'
        status:
          type: string
          enum:
          - OK
          - MISSING_QUANTITY
          - UNRECOGNIZED_FOOD
        servingSizes:
          type: array
          items:
            $ref: '#/components/schemas/Quantity'
        servingsPerContainer:
          type: number
    Nutrients:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/NutrientInfo'
    NutrientInfo:
      type: object
      properties:
        label:
          type: string
        quantity:
          type: number
        unit:
          type: string
    Recipe:
      type: object
      description: The input recipe.
      required:
      - title
      - ingr
      properties:
        title:
          description: The recipe title.
          type: string
        ingr:
          description: The ingredients.
          type: array
          items:
            type: string
        url:
          description: The recipe URL.
          type: string
        summary:
          description: The recipe summary.
          type: string
        yield:
          description: Number of servings. If this is not present the number is inferred.
          type: string
        time:
          type: string
        img:
          description: The recipe image (URL).
          type: string
        prep:
          description: Cooking instructions
          type: array
          items:
            type: string