Recipe on Cookifed

Retrieve the required recipe

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/accounts/{account_id}/recipes/{slug}

Fetch a specific recipe by its slug for the given account. The slug is a URL-safe identifier derived from the recipe’s name at creation time.

Parameters

Name	In	Required	Type	Description
`account_id`	path	yes	integer
`slug`	path	yes	string

Request Body

None.

Responses

200

recipe

Schema: recipe_output

`recipe_output`

Field	Type	Required
`id`	integer	yes
`slug`	string	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`locale`	string	yes
`serving`	integer	yes
`serving_type`	string	yes
`visibility`	string	yes
`account`	`account_output`	yes
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes

Boost a recipe

Mon, 01 Jan 0001 00:00:00 +0000

POST /api/v1/recipes/{id}/boost

Share the specified recipe with the authenticated user’s followers. A boost creates a re-share event on the timeline without duplicating the original.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

204

recipe boosted

Unboost a recipe

Mon, 01 Jan 0001 00:00:00 +0000

DELETE /api/v1/recipes/{id}/boost

Remove a previously created boost on the specified recipe, retracting the re-share from the authenticated user’s followers’ timelines.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

204

recipe unboosted

Recursively retrieve the specified recipe's linked recipes

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/recipes/{recipe_id}/links

Traverse the recipe’s step-link graph and return all transitively linked recipes in a flat list. Publicly accessible without authentication.

Required Scopes

None (public endpoint).

Parameters

Name	In	Required	Type	Description
`recipe_id`	path	yes	integer

Request Body

None.

Responses

200

links

Schema: array[recipe_output]

`recipe_output`

Field	Type	Required
`id`	integer	yes
`slug`	string	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`locale`	string	yes
`serving`	integer	yes
`serving_type`	string	yes
`visibility`	string	yes
`account`	`account_output`	yes
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes

Retrieve the recipe's media available to the current user

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/recipes/{recipe_id}/media

Returns media attachments from bakings of the specified recipe that are accessible to the authenticated user, as extended_medium_output objects.

Parameters

Name	In	Required	Type	Description
`recipe_id`	path	yes	integer

Request Body

None.

Responses

200

media

Schema: array[extended_medium_output]

Retrieve all of the user's recipes

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/recipes

Returns recipes owned by the authenticated user, including full ingredient and step data. Results are ordered by creation date, newest first.

Required Scopes

read

Request Body

None.

Responses

200

recipes list

Schema: array[recipe_output]

`recipe_output`

Field	Type	Required
`id`	integer	yes
`slug`	string	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`locale`	string	yes
`serving`	integer	yes
`serving_type`	string	yes
`visibility`	string	yes
`account`	`account_output`	yes
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes

Create a new recipe

Mon, 01 Jan 0001 00:00:00 +0000

POST /api/v1/recipes

Create a new recipe with a name, description, serving size, visibility, and optional ingredients and steps. Returns the full created recipe object.

Required Scopes

write

Request Body

Content-Type: application/json

Schema: object

Field	Type	Required	Description
`recipe`	`recipe_create_input`	no

Responses

201

recipe created

Schema: recipe_output

`recipe_output`

Field	Type	Required
`id`	integer	yes
`slug`	string	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`locale`	string	yes
`serving`	integer	yes
`serving_type`	string	yes
`visibility`	string	yes
`account`	`account_output`	yes
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes

422

invalid request

Retrieve the specified recipe by its id

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/recipes/{id}

Fetch a single recipe by its numeric ID. Publicly accessible without authentication. Returns the full recipe including all ingredients and steps.

Required Scopes

None (public endpoint).

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

200

single recipe

Schema: recipe_output

`recipe_output`

Field	Type	Required
`id`	integer	yes
`slug`	string	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`locale`	string	yes
`serving`	integer	yes
`serving_type`	string	yes
`visibility`	string	yes
`account`	`account_output`	yes
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes

Update an existing recipe

Mon, 01 Jan 0001 00:00:00 +0000

PATCH /api/v1/recipes/{id}

Update one or more fields of the specified recipe including name, description, ingredients, and steps. Only the owning account may update it.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

Content-Type: application/json

Schema: object

Field	Type	Required	Description
`recipe`	`recipe_input`	no

Responses

204

recipe updated

422

invalid request

Schema: errors

`errors`

Field	Type	Required	Description
`errors`	object	yes

Delete a recipe

Mon, 01 Jan 0001 00:00:00 +0000

DELETE /api/v1/recipes/{id}

Permanently delete the specified recipe and all its steps and ingredients. Only the owning account may delete it. This action cannot be undone.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer