Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
number
required

Amount

Required range: x >= 0
method
enum<string>

Brew method

Available options:
pour-over,
chemex,
french-press,
aeropress,
drip,
moka-pot,
turkish,
cold-brew-concentrate,
cold-brew,
espresso,
custom
customRatio
number

Custom ratio (1:x)

Required range: 3 <= x <= 30
strength
enum<string>

Strength

Available options:
mild,
standard,
strong
solveFrom
enum<string>

I know…

Available options:
water,
coffee,
cups
waterUnit
enum<string>

Water unit

Available options:
ml,
floz
coffeeUnit
enum<string>

Coffee unit

Available options:
g,
oz,
tbsp
cupSize
enum<string>

Cup size

Available options:
6,
8,
12

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.