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
calories
number
required

Daily calorie goal

Required range: 800 <= x <= 8000
preset
enum<string>

Diet preset

Available options:
balanced,
highProtein,
keto,
endurance,
zone,
custom
proteinPercent
number

Protein %

Required range: 0 <= x <= 100
carbsPercent
number

Carbs %

Required range: 0 <= x <= 100
fatPercent
number

Fat %

Required range: 0 <= x <= 100
meals
number

Meals per day

Required range: 1 <= x <= 8

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.