Get a recipe

A recipe of the account, or a public one, with its ingredients, instructions and nutrients.

Requires the library:read permission.

GET/recipes/{recipe_id}

Autorización

AuthorizationToken Bearer (API Key) · headerobligatorio

Almendra API key, bound to one professional account. Send it as Authorization: Bearer YOUR_API_KEY.

Ámbitos:library:read

Parámetros de ruta

recipe_idstringobligatorio

Recipe ID

coincide con ^[0-9a-fA-F]{24}$

Respuestas

200

Recipe

_idstringobligatorio

namestringobligatorio

portionsnumber

preparationTimeMinutesnumber

cookingTimeMinutesnumber

caloriesKcalnumber

proteinGnumber

carbsGnumber

fatGnumber

tagsstring[]obligatorio

imageUrlstring

isPublicbooleanobligatorio

Shared with every Almendra account

isDraftbooleanobligatorio

Still being written (not yet offered in meal plans)

createdByThisAccountbooleanobligatorio

difficultystring

ingredientsRecipeIngredient[]obligatorio

Mostrar propiedades

Array de RecipeIngredient

foodstring

Food ID (left out in other accounts' public recipes)

foodNamestringobligatorio

quantitynumberobligatorio

unitstringobligatorio

instructionsstring[]obligatorio

nutrientsobjectobligatorio

Every other nutrient the food has, per 100 g, keyed by name and unit (sodium_mg, vitaminB12_ug, …).

measuresFoodMeasure[]obligatorio

Household measures and their weight in grams, including the account's own measures for this food. A meal plan's unit is one of these (or grams).

Mostrar propiedades

Array de FoodMeasure

amountnumberobligatorio

descriptionstringobligatorio

gramsnumberobligatorio

400

Invalid path parameter, query parameter or request body

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

Valores permitidos:bad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictpayload_too_largeunsupported_media_typeunprocessable_entityrate_limitedinternal_errornot_implementedbad_gatewayservice_unavailablegateway_timeout

messagestringobligatorio

Human-readable explanation of what went wrong.

401

Missing or invalid API key

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

403

The account behind the API key has no active paid plan, or the key lacks the permission this operation needs

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

404

Recipe not found

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

429

Rate limit exceeded (600 requests per 60 seconds); retry after Retry-After seconds

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

500

Unexpected server error

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

Pruébalo

Servidor

URL baseURL base personalizadaSi se define, sustituye al servidor seleccionado.

Autorización

Token Bearer (API Key)Recordar en este dispositivoIncluir mis valores en los ejemplos

Parámetros

recipe_idpath*Recipe ID

Solicitud

curl -X GET 'https://api.almendra.io/openapi/v1/recipes/507f1f77bcf86cd799439011' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response: Response = await fetch("https://api.almendra.io/openapi/v1/recipes/507f1f77bcf86cd799439011", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://api.almendra.io/openapi/v1/recipes/507f1f77bcf86cd799439011",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.almendra.io/openapi/v1/recipes/507f1f77bcf86cd799439011",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Respuesta

{
  "_id": "string",
  "name": "Quinua con pollo",
  "portions": 0,
  "preparationTimeMinutes": 0,
  "cookingTimeMinutes": 0,
  "caloriesKcal": 0,
  "proteinG": 0,
  "carbsG": 0,
  "fatG": 0,
  "tags": [
    "string"
  ],
  "imageUrl": "string",
  "isPublic": true,
  "isDraft": true,
  "createdByThisAccount": true,
  "difficulty": "string",
  "ingredients": [
    {
      "food": "string",
      "foodName": "string",
      "quantity": 0,
      "unit": "string"
    }
  ],
  "instructions": [
    "string"
  ],
  "nutrients": {
    "fiber_g": 0,
    "sodium_mg": 74,
    "iron_mg": 1
  },
  "measures": [
    {
      "amount": 1,
      "description": "taza",
      "grams": 240
    }
  ]
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

Get a recipe

¿No encuentras lo que buscas?