Analyze Recipe Instructions

v1.0.0

This endpoint allows you to break down instructions into atomic steps. Furthermore, each step will contain the ingredients and equipment required. Additionally, all ingredients and equipment from the recipe's instructions will be extracted independently of the step they're used in.

Input

{
  "type": "object",
  "properties": {
    "Content-Type": {
      "type": "string",
      "enum": [
        "application/x-www-form-urlencoded",
        "application/json",
        "multipart/form-data"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "equipment",
    "ingredients",
    "parsedInstructions"
  ],
  "properties": {
    "equipment": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "ingredients": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "parsedInstructions": {
      "type": "array",
      "items": {
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "steps": {
            "type": "array",
            "items": {
              "required": [
                "number",
                "step"
              ],
              "properties": {
                "equipment": {
                  "type": "array",
                  "items": {
                    "required": [
                      "id",
                      "name",
                      "localizedName",
                      "image"
                    ],
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "image": {
                        "type": "string"
                      },
                      "localizedName": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  }
                },
                "ingredients": {
                  "type": "array",
                  "items": {
                    "required": [
                      "id",
                      "name",
                      "localizedName",
                      "image"
                    ],
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "image": {
                        "type": "string"
                      },
                      "localizedName": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  }
                },
                "number": {
                  "type": "number"
                },
                "step": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}