Quickstart

Updated Jul 17, 2026

Get from zero to a successful prediction in a few minutes.

1. Create an API key

  1. Open the dashboard and sign in.
  2. Go to API keys and create a key.
  3. Copy the secret once — it is shown only at creation time.

Keys look like:

  • hf_test_… — for development and playground use
  • hf_live_… — for production traffic

See Authentication for the exact header format.

2. Base URL

All requests go to:

https://api.humanform.app

3. First request

Predict median male stature for the US (values in millimetres):

curl -sS https://api.humanform.app/v1/predict \
  -H "Authorization: Bearer hf_test_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "measurement": "Stature",
    "gender": "Male",
    "age": 30,
    "percentile": 50,
    "country": "US",
    "unit": "mm"
  }'

Example response:

{
  "measurement": "Stature",
  "gender": "Male",
  "country": "US",
  "clothing": "nude",
  "posture": "standing_erect",
  "value": 1765.3,
  "unit": "mm",
  "source": "modeled"
}

Next steps

  • Predict — full request fields including clothing and posture
  • Predict range — multiple percentiles at once
  • Errors — how failures are returned