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

Weight

Required range: 0.1 <= x <= 200
foodKcal
number
required

kcal / 100 g

Required range: 30 <= x <= 800
petSpecies
enum<string>

Species

Available options:
dog,
cat
weightUnit
enum<string>

Weight Unit

Available options:
kg,
lbs
dogLifeStage
enum<string>

Life Stage & Activity

Available options:
3.0,
2.0,
1.6,
1.8,
3.0,
4.0,
1.4,
1.0
catLifeStage
enum<string>

Life Stage & Activity

Available options:
2.5,
1.2,
1.4,
1.1,
0.8
foodType
enum<string>

Food Type

Available options:
dry,
wet,
raw,
custom
mealsPerDay
enum<string>

Meals / day

Available options:
1,
2,
3,
4

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.