Baking on Cookifed

Retrieve bakings linked from a baking

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

GET /api/v1/bakings/{baking_id}/links

Returns all bakings reachable through the step links of the specified baking, recursively up to the maximum link depth, filtered to those visible to the current user. Publicly accessible without authentication.

Required Scopes

None (public endpoint).

Parameters

Name	In	Required	Type	Description
`baking_id`	path	yes	integer

Request Body

None.

Responses

200

linked bakings

Schema: array[baking_output]

`baking_output`

Field	Type	Required
`id`	integer	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`status`	string	yes
`serving`	integer	yes
`prepared_at`	string	yes
`recipe_id`	integer	no
`serving_type`	string	no
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`published_at`	string	yes
`account`	`account_output`	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes
`media`	array[`medium_output`]	yes

Publish a baking

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

POST /api/v1/bakings/{id}/publish

Publish the specified baking, making it visible according to the chosen visibility level: public, unlisted, or private.

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
`baking`	object	no

Responses

204

baking published

Unpublish a baking

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

DELETE /api/v1/bakings/{id}/publish

Revert a published baking back to draft state, hiding it from public and follower timelines. Only the owning account may unpublish.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

204

baking deleted

Retrieve all of the user's bakings

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

GET /api/v1/bakings

Returns bakings belonging to the authenticated user. Optionally filter by start_date, end_date, and a comma-separated list of status values.

Required Scopes

read

Parameters

Name	In	Required	Type
`start_date`	query	no	string
`end_date`	query	no	string
`status`	query	no	string

Request Body

None.

Responses

200

bakings list

Schema: array[baking_output]

`baking_output`

Field	Type	Required
`id`	integer	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`status`	string	yes
`serving`	integer	yes
`prepared_at`	string	yes
`recipe_id`	integer	no
`serving_type`	string	no
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`published_at`	string	yes
`account`	`account_output`	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes
`media`	array[`medium_output`]	yes

Create a new baking

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

POST /api/v1/bakings

Create a baking session linked to a recipe. Requires a recipe_id, name, and prepared_at date. The serving count must be a positive integer.

Required Scopes

write

Request Body

Content-Type: application/json

Schema: object

Field	Type	Required	Description
`baking`	`baking_create_input`	no

Responses

201

baking created

Schema: baking_output

`baking_output`

Field	Type	Required
`id`	integer	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`status`	string	yes
`serving`	integer	yes
`prepared_at`	string	yes
`recipe_id`	integer	no
`serving_type`	string	no
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`published_at`	string	yes
`account`	`account_output`	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes
`media`	array[`medium_output`]	yes

422

invalid request

Retrieve the specified baking by its id

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

GET /api/v1/bakings/{id}

Fetch a single baking by its numeric ID. Publicly accessible without authentication. Returns the full baking object including linked recipe and status.

Required Scopes

None (public endpoint).

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

200

single baking

Schema: baking_output

`baking_output`

Field	Type	Required
`id`	integer	yes
`name`	string	yes
`description`	string	yes
`description_html`	string	yes
`status`	string	yes
`serving`	integer	yes
`prepared_at`	string	yes
`recipe_id`	integer	no
`serving_type`	string	no
`likes_count`	integer	yes
`boosts_count`	integer	yes
`liked`	boolean	yes
`boosted`	boolean	yes
`published_at`	string	yes
`account`	`account_output`	yes
`ingredients`	array[`ingredient_output`]	yes
`steps`	array[]	yes
`media`	array[`medium_output`]	yes

Update an existing baking

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

PATCH /api/v1/bakings/{id}

Update one or more attributes of the specified baking, such as name, prepared_at date, or serving count. 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
`baking`	`baking_input`	no

Responses

204

baking updated

422

invalid request

Schema: errors

`errors`

Field	Type	Required	Description
`errors`	object	yes

Delete a baking

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

DELETE /api/v1/bakings/{id}

Permanently delete the specified baking and all associated media. 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

Request Body

None.

Responses

204

baking deleted

Boost a baking

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

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

Share the specified baking 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

baking boosted

Unboost a baking

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

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

Remove a previously created boost on the specified baking, 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

baking unboosted

Create a new media for a baking

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

POST /api/v1/bakings/{eventable_id}/media

Upload and attach a new image to the specified baking. Only image files are accepted; other formats such as PDF are rejected.

Required Scopes

write

Request Body

Content-Type: multipart/form-data

Schema: object

Field	Type	Required	Description
`media`	`medium_input`	no

Responses

201

media created

Schema: medium_output

`medium_output`

Field	Type	Required
`id`	integer	yes
`description`	string	yes
`created_at`	string	yes
`original`	string	yes
`medium`	string	yes
`small`	string	yes

422

invalid request

Update a media for a baking

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

PATCH /api/v1/bakings/{eventable_id}/media/{id}

Update the alt-text description of an existing media attachment on the specified baking. Only the description field may be modified via this endpoint.

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
`media`	object	no

Responses

204

media updated

Delete a media for a baking

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

DELETE /api/v1/bakings/{eventable_id}/media/{id}

Permanently remove the specified media attachment from the baking. The file is deleted from storage and can no longer be referenced.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer