Inputs
| Field | Required | Description |
|---|---|---|
profile | yes | Behavioural profile id. One of despondent, dementia_alzheimers. |
area_type + area shape | yes | circle (with center + radius_m), polygon (with polygon), or path (with path and an optional buffer_m — defaults to 50 m, capped at 500 m). |
datetime | yes | ISO 8601 scenario time. Drives weather lookup and time-of-day signals. |
age_years | no | Subject age. Optional — omit when unknown. Supplying it sharpens the prediction. |
initial_bearing_deg | no | Initial direction of travel. Focuses results to a directional cone. |
weather | no | Manual override. When omitted, weather is fetched for datetime. |
Example prompts
- “Predict the most likely locations for a despondent 75-year-old last seen heading south from this point”
- “Run a prediction for a dementia patient, age 80, in this 2km radius area”
- “Generate a search priority map for this polygon area, the subject was last seen at 10pm”
- “Predict with heavy rain and strong wind conditions for this search area”
What you get back
A rich response (default) returns the following keys instructuredContent:
top_results— the top 50 H3 hexagons ranked by score (highest first). Each row carrieshex,score, and the cell centroid aslat/lngso the result can be chained directly intosearch_places,reverse_geocode,get_directions, etc. without a separate hex-to-coordinates step.scoreis an integer 0–30 — a relative confidence score across the surviving hexes in this prediction, NOT a probability or percentage.cells— every scored hex (the full grid). Each row carrieshexandscore. Suppress withinclude_hexes: falseif you don’t need the full surface in the structured response — the rendered hex layer inrenderis independent of this field.summary—hex_count(total hexes scored) andprocessing_time_ms.coverage—top_n(how many rows are intop_results),total_count(how many were scored),coverage_percent(score mass held by the returned rows), andtruncated(false when every scored hex was returned). Usecoverage_percentto gauge how concentrated the prediction is — a high value means the top hexes hold most of the likelihood; a low value means the search area is genuinely diffuse.render— a singleh3-cellslayer ready to drop into a map.style_hints.value_rangecarries[min, max]so the renderer can pick a colour scale. See render envelopes.
Response controls
| Flag | Default | Effect |
|---|---|---|
include_hexes | true | Includes the full hex grid as cells. Set to false to keep only top_results in the structured response (the render envelope still carries the full grid). |
include_render | true | Includes the render envelope. Set to false for text-only callers that won’t render the result. |
compact | false | When true, omits both the full grid (cells) and the render envelope, leaving only top_results, summary, and coverage. The compact response is what every existing chaining flow needs. |
compact: true. Renderer clients should leave the defaults.