{
  "openapi": "3.0.1",
  "info": {
    "title": "BBC Good Food Recipe & Nutrition Extractor",
    "description": "Search BBC Good Food by keyword, browse a recipe category, or fetch direct recipe URLs and get ingredients, method steps, timings, calories, rating, and cuisine for each recipe.",
    "version": "1.0",
    "x-build-id": "wtl3T6UszvJjAj1pd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~bbc-good-food-recipe-and-nutrition-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-bbc-good-food-recipe-and-nutrition-extractor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/dataspryva~bbc-good-food-recipe-and-nutrition-extractor/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-bbc-good-food-recipe-and-nutrition-extractor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/dataspryva~bbc-good-food-recipe-and-nutrition-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-bbc-good-food-recipe-and-nutrition-extractor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "allRecipes",
              "byCategory",
              "byUrl",
              "bySitemap"
            ],
            "type": "string",
            "description": "How to find recipes. Search uses BBC Good Food's own search. Browse all walks the full index with the same filters. Collection takes a slug or collection URL. Recipe URLs fetches exact pages. Sitemap walks newest sitemap files first.",
            "default": "search"
          },
          "query": {
            "title": "Search Query",
            "type": "string",
            "description": "Keyword for mode=search (e.g. 'chicken curry', 'vegan cake'). Leave empty to browse every recipe."
          },
          "category": {
            "title": "Collection Slug or URL",
            "type": "string",
            "description": "Collection for mode=byCategory. Use a slug like 'pasta-recipes', 'vegan-recipes', 'baking-recipes', 'dessert-recipes', or paste a full https://www.bbcgoodfood.com/recipes/collection/... URL. Leave empty to browse all recipes.",
            "default": "pasta-recipes"
          },
          "cuisine": {
            "title": "Cuisine",
            "type": "string",
            "description": "Optional cuisine filter; comma-separate several values, e.g. 'italian,mediterranean'. Common values: italian, british, indian, asian, chinese, french, mexican, thai, mediterranean, american, spanish, greek, middle-eastern, japanese, caribbean, moroccan, turkish, vietnamese."
          },
          "diets": {
            "title": "Dietary Filters",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep recipes carrying every selected dietary tag. Empty array = no diet filter.",
            "items": {
              "type": "string",
              "enum": [
                "vegetarian",
                "vegan",
                "healthy",
                "nut-free",
                "egg-free",
                "dairy-free",
                "gluten-free",
                "low-sugar",
                "low-calorie",
                "low-fat",
                "high-fibre",
                "high-protein"
              ],
              "enumTitles": [
                "Vegetarian",
                "Vegan",
                "Healthy",
                "Nut-free",
                "Egg-free",
                "Dairy-free",
                "Gluten-free",
                "Low sugar",
                "Low calorie",
                "Low fat",
                "High fibre",
                "High protein"
              ]
            },
            "default": []
          },
          "difficulty": {
            "title": "Difficulty",
            "enum": [
              "",
              "easy",
              "more-effort",
              "a-challenge"
            ],
            "type": "string",
            "description": "Keep only recipes at this skill level.",
            "default": ""
          },
          "mealTypes": {
            "title": "Meal Types",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep recipes matching at least one selected meal type. Empty array = no meal filter.",
            "items": {
              "type": "string",
              "enum": [
                "afternoon-tea",
                "breakfast",
                "brunch",
                "buffet",
                "condiment",
                "dessert",
                "dinner",
                "lunch",
                "main-course",
                "pasta",
                "side-dish",
                "snack",
                "soup",
                "starter",
                "supper",
                "treat",
                "vegetable"
              ],
              "enumTitles": [
                "Afternoon tea",
                "Breakfast",
                "Brunch",
                "Buffet",
                "Condiment",
                "Dessert",
                "Dinner",
                "Lunch",
                "Main course",
                "Pasta",
                "Side dish",
                "Snack",
                "Soup",
                "Starter",
                "Supper",
                "Treat",
                "Vegetable"
              ]
            },
            "default": []
          },
          "minRating": {
            "title": "Minimum Rating",
            "minimum": 1,
            "maximum": 5,
            "type": "number",
            "description": "Keep recipes rated at or above this community rating (1.0-5.0)."
          },
          "maxTotalTimeMinutes": {
            "title": "Max Total Time (minutes)",
            "minimum": 1,
            "maximum": 1440,
            "type": "integer",
            "description": "Keep recipes whose published total time is at most this many minutes."
          },
          "maxCalories": {
            "title": "Max Calories (kcal)",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Keep recipes at or below this calories-per-serving value."
          },
          "minServings": {
            "title": "Minimum Servings",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Keep recipes whose published yield is at least this many servings."
          },
          "sortBy": {
            "title": "Sort By",
            "enum": [
              "relevant",
              "published",
              "rating",
              "quickest"
            ],
            "type": "string",
            "description": "Result order for search and all-recipes modes; collection and URL modes sort the collected rows.",
            "default": "relevant"
          },
          "startUrls": {
            "title": "Recipe URLs",
            "type": "array",
            "description": "Recipe pages for mode=byUrl. Accepts https://www.bbcgoodfood.com/recipes/... and /premium/... links.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Max Recipes",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of recipe records to return.",
            "default": 20
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}