Skip to main content
POST
Add an inventory item

Authorizations

X-API-Key
string
header
required

An API key created from a signed-in session. See Authentication.

Body

application/json
category
enum<string>
required

Ingredient category

Available options:
fermentable,
hop,
yeast,
misc
name
string
required

Ingredient name

Minimum string length: 1
amount
number
default:0

Quantity on hand

Required range: x >= 0
amount_unit
string
default:kg

Unit of measure — free text, not converted

Minimum string length: 1
type
string | null

Sub-type (grain, sugar, spice, …)

form
string | null

Form (liquid, dry — mainly for yeast)

origin
string | null

Country or region of origin

alpha_acid
number | null

Alpha acid percentage (hops)

color_srm
number | null

Colour in SRM (fermentables)

yield_percent
number | null

Extract yield percentage (fermentables)

attenuation
number | null

Apparent attenuation (yeasts)

year
integer | null

Crop year (hops)

notes
string | null

Freeform notes

Response

The created item

id
string<uuid>
read-only

Unique identifier

user_id
string
read-only

Owning account

category
enum<string>

Ingredient category

Available options:
fermentable,
hop,
yeast,
misc
name
string

Ingredient name

amount
number

Quantity on hand

amount_unit
string

Unit of measure

type
string | null

Sub-type

form
string | null

Form

origin
string | null

Country or region of origin

alpha_acid
number | null

Alpha acid percentage

color_srm
number | null

Colour in SRM

yield_percent
number | null

Extract yield percentage

attenuation
number | null

Apparent attenuation

year
integer | null

Crop year

notes
string | null

Freeform notes

created_at
string<date-time>
read-only

ISO 8601 timestamp

updated_at
string<date-time>
read-only

ISO 8601 timestamp