Predict

curl --request POST \
  --url https://api.footstep.ai/v1/predict \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "profile": "despondent",
  "area": {
    "type": "circle",
    "center": {
      "lat": 51.5074,
      "lng": -0.1278
    },
    "radius_m": 2000
  },
  "params": {
    "age_years": 75,
    "initial_bearing_deg": 180,
    "datetime": "2025-06-15T14:00:00Z"
  }
}
'

{
  "profile": "<string>",
  "model_version": "<string>",
  "results": [
    {
      "hex": "<string>",
      "score": 15
    }
  ],
  "summary": {
    "hex_count": 123,
    "processing_time_ms": 123
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

POST

predict

curl --request POST \
  --url https://api.footstep.ai/v1/predict \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "profile": "despondent",
  "area": {
    "type": "circle",
    "center": {
      "lat": 51.5074,
      "lng": -0.1278
    },
    "radius_m": 2000
  },
  "params": {
    "age_years": 75,
    "initial_bearing_deg": 180,
    "datetime": "2025-06-15T14:00:00Z"
  }
}
'

{
  "profile": "<string>",
  "model_version": "<string>",
  "results": [
    {
      "hex": "<string>",
      "score": 15
    }
  ],
  "summary": {
    "hex_count": 123,
    "processing_time_ms": 123
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Research Preview — Predictions are generated from behavioural models that have not yet been fully validated against real-world outcomes. Access is granted on request — contact support@footstep.ai.

Generate spatial probability distributions for missing person scenarios. Given a last known position, a behavioural profile (age, condition, possible intent), and a search area, predict returns a probability-ranked grid covering that area — so search teams can prioritise the highest-likelihood ground. The search area can be a circle (centre + radius), a polygon (GeoJSON), or a buffered path (LineString + buffer width). Weather and time-of-day are folded in automatically; weather can be overridden with explicit conditions or disabled entirely.

Authorizations

x-api-key

string

header

required

Your Footstep API key

Body

application/json

profile

enum<string>

required

Behavioural profile id. Must be one of the listed values.

Available options:

despondent,

dementia_alzheimers

area

object

required

Search area — circle, polygon, or buffered path

Option 1
Option 2
Option 3

Show child attributes

params

object

required

Show child attributes

Response

Prediction results with per-hex probabilities

profile

string

required

The profile used for this prediction

model_version

string

required

Model version that produced the prediction

results

object[]

required

Per-hex predictions sorted by score (highest first)

Show child attributes

summary

object

required

Show child attributes

confidence

enum<string>

required

Model confidence level for the search area

Available options:

high,

medium,

low

Introduction

Routing

Geocoding

Natural Language

Predict

Authorizations

Body

Response