Create Plan

curl --request POST \
  --url https://api.example.com/plan/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "daily_menus": [
    {
      "day_of_week": 123,
      "plan_id": 123,
      "meal_details": [
        {
          "recipe_id": 123,
          "schedule": 123,
          "status": 123,
          "meal_type": "<string>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.example.com/plan/"

payload = { "daily_menus": [
        {
            "day_of_week": 123,
            "plan_id": 123,
            "meal_details": [
                {
                    "recipe_id": 123,
                    "schedule": 123,
                    "status": 123,
                    "meal_type": "<string>"
                }
            ]
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    daily_menus: [
      {
        day_of_week: 123,
        plan_id: 123,
        meal_details: [{recipe_id: 123, schedule: 123, status: 123, meal_type: '<string>'}]
      }
    ]
  })
};

fetch('https://api.example.com/plan/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/plan/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'daily_menus' => [
        [
                'day_of_week' => 123,
                'plan_id' => 123,
                'meal_details' => [
                                [
                                                                'recipe_id' => 123,
                                                                'schedule' => 123,
                                                                'status' => 123,
                                                                'meal_type' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/plan/"

	payload := strings.NewReader("{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/plan/")
  .header("Content-Type", "application/json")
  .body("{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/plan/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "user_id": 123,
  "active": true,
  "created_at": {},
  "updated_at": {},
  "daily_menus": [
    {
      "id": 123,
      "day_of_week": 123,
      "meal_details": [
        {
          "id": 123,
          "recipe_id": 123,
          "schedule": 123,
          "status": 123,
          "meal_type": "<string>",
          "recipe": {
            "id": 123,
            "name": "<string>",
            "calories": 123,
            "protein": 123,
            "carbs": 123,
            "fat": 123,
            "image_url": "<string>",
            "recipe_url": "<string>",
            "recipe_id": 123,
            "ingredients": "<string>",
            "meal_types": [
              {
                "id": 123,
                "name": "<string>"
              }
            ],
            "diet_types": [
              {
                "id": 123,
                "name": "<string>"
              }
            ]
          }
        }
      ]
    }
  ]
}

POST

plan

Create Plan

curl --request POST \
  --url https://api.example.com/plan/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "daily_menus": [
    {
      "day_of_week": 123,
      "plan_id": 123,
      "meal_details": [
        {
          "recipe_id": 123,
          "schedule": 123,
          "status": 123,
          "meal_type": "<string>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.example.com/plan/"

payload = { "daily_menus": [
        {
            "day_of_week": 123,
            "plan_id": 123,
            "meal_details": [
                {
                    "recipe_id": 123,
                    "schedule": 123,
                    "status": 123,
                    "meal_type": "<string>"
                }
            ]
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    daily_menus: [
      {
        day_of_week: 123,
        plan_id: 123,
        meal_details: [{recipe_id: 123, schedule: 123, status: 123, meal_type: '<string>'}]
      }
    ]
  })
};

fetch('https://api.example.com/plan/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/plan/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'daily_menus' => [
        [
                'day_of_week' => 123,
                'plan_id' => 123,
                'meal_details' => [
                                [
                                                                'recipe_id' => 123,
                                                                'schedule' => 123,
                                                                'status' => 123,
                                                                'meal_type' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/plan/"

	payload := strings.NewReader("{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/plan/")
  .header("Content-Type", "application/json")
  .body("{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/plan/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"daily_menus\": [\n    {\n      \"day_of_week\": 123,\n      \"plan_id\": 123,\n      \"meal_details\": [\n        {\n          \"recipe_id\": 123,\n          \"schedule\": 123,\n          \"status\": 123,\n          \"meal_type\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "user_id": 123,
  "active": true,
  "created_at": {},
  "updated_at": {},
  "daily_menus": [
    {
      "id": 123,
      "day_of_week": 123,
      "meal_details": [
        {
          "id": 123,
          "recipe_id": 123,
          "schedule": 123,
          "status": 123,
          "meal_type": "<string>",
          "recipe": {
            "id": 123,
            "name": "<string>",
            "calories": 123,
            "protein": 123,
            "carbs": 123,
            "fat": 123,
            "image_url": "<string>",
            "recipe_url": "<string>",
            "recipe_id": 123,
            "ingredients": "<string>",
            "meal_types": [
              {
                "id": 123,
                "name": "<string>"
              }
            ],
            "diet_types": [
              {
                "id": 123,
                "name": "<string>"
              }
            ]
          }
        }
      ]
    }
  ]
}

Authentication

This endpoint requires authentication. Include a valid JWT token in the Authorization header.

Authorization: Bearer <token>

Request Body

array

default:"[]"

List of daily menus to include in the plan

integer

required

Day of the week (1-7, where 1 is Monday)

integer

required

Plan ID to which this daily menu belongs

array

default:"[]"

List of meal details for this day

integer

required

Recipe ID associated with the meal detail

integer

required

Order of meals (1-6)

integer

required

Status of the meal detail (0: pending, 1: completed)

string

required

Type of meal. Possible values: breakfast, lunch, dinner, snack

Request Example

{
  "daily_menus": [
    {
      "day_of_week": 1,
      "plan_id": 1,
      "meal_details": [
        {
          "recipe_id": 12345,
          "schedule": 1,
          "status": 0,
          "meal_type": "breakfast"
        },
        {
          "recipe_id": 12346,
          "schedule": 2,
          "status": 0,
          "meal_type": "lunch"
        }
      ]
    },
    {
      "day_of_week": 2,
      "plan_id": 1,
      "meal_details": [
        {
          "recipe_id": 12347,
          "schedule": 1,
          "status": 0,
          "meal_type": "breakfast"
        }
      ]
    }
  ]
}

Response

integer

required

Unique identifier for the plan

integer

required

ID of the user who owns this plan

boolean

required

Indicates whether the plan is active

datetime

required

Timestamp when the plan was created

datetime

required

Timestamp when the plan was last updated

array

required

List of daily menus in the plan

integer

required

Unique identifier for the daily menu

integer

required

Day of the week (1-7, where 1 is Monday)

array

required

List of meal details for this day

integer

required

ID of the meal detail

integer

required

Recipe ID associated with the meal detail

integer

required

Order of meals (1-6)

integer

required

Status of the meal detail (0: pending, 1: completed)

string

required

Type of meal. Possible values: breakfast, lunch, dinner, snack

object

required

Associated recipe details

integer

required

Unique identifier for the recipe

string

required

Name of the recipe

integer

required

Calorie content (minimum: 0)

integer

required

Protein content in grams (minimum: 0)

integer

required

Carbohydrate content in grams (minimum: 0)

integer

required

Fat content in grams (minimum: 0)

string

URL to the recipe image

string

URL to the full recipe details

integer

required

External recipe identifier

string

required

Comma-separated list of ingredients

array

required

List of applicable meal types

integer

required

Category ID

string

required

Category name

array

required

List of applicable diet types

integer

required

Category ID

string

required

Category name

Response Example

{
  "id": 1,
  "user_id": 42,
  "active": true,
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-01T10:00:00Z",
  "daily_menus": [
    {
      "id": 1,
      "day_of_week": 1,
      "meal_details": [
        {
          "id": 1,
          "recipe_id": 12345,
          "schedule": 1,
          "status": 0,
          "meal_type": "breakfast",
          "recipe": {
            "id": 1,
            "name": "Spaghetti Carbonara",
            "calories": 400,
            "protein": 20,
            "carbs": 50,
            "fat": 15,
            "image_url": "https://example.com/image.jpg",
            "recipe_url": "https://example.com/recipe",
            "recipe_id": 12345,
            "ingredients": "Spaghetti, eggs, pancetta, parmesan cheese, black pepper",
            "meal_types": [
              {
                "id": 1,
                "name": "lunch"
              }
            ],
            "diet_types": [
              {
                "id": 1,
                "name": "high_protein"
              }
            ]
          }
        },
        {
          "id": 2,
          "recipe_id": 12346,
          "schedule": 2,
          "status": 0,
          "meal_type": "lunch",
          "recipe": {
            "id": 2,
            "name": "Caesar Salad",
            "calories": 250,
            "protein": 15,
            "carbs": 20,
            "fat": 12,
            "image_url": "https://example.com/salad.jpg",
            "recipe_url": "https://example.com/recipe/salad",
            "recipe_id": 12346,
            "ingredients": "Romaine lettuce, croutons, parmesan, caesar dressing",
            "meal_types": [
              {
                "id": 2,
                "name": "lunch"
              }
            ],
            "diet_types": [
              {
                "id": 3,
                "name": "low_calorie"
              }
            ]
          }
        }
      ]
    }
  ]
}

Error Responses

The request lacks valid authentication credentials

{
  "detail": "Not authenticated"
}

Invalid request body or validation error

{
  "detail": [
    {
      "loc": ["body", "daily_menus", 0, "day_of_week"],
      "msg": "ensure this value is greater than or equal to 1",
      "type": "value_error.number.not_ge"
    }
  ]
}

An unexpected error occurred on the server

{
  "detail": "Internal server error"
}

Authentication

Profile

Plans

Chat

Recommendations

Create Plan

Authentication

Request Body

Request Example

Response

Response Example

Error Responses

​Authentication

​Request Body

​Request Example

​Response

​Response Example

​Error Responses

Authentication

Request Body

Request Example

Response

Response Example

Error Responses