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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Footstep","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/footstep/QNknRZ9DgHsEJ89b/logo/light.svg?fit=max\u0026auto=format\u0026n=QNknRZ9DgHsEJ89b\u0026q=85\u0026s=9e6862a6bf9136c6f3edc8efa1869f5d","dark":"https://mintcdn.com/footstep/QNknRZ9DgHsEJ89b/logo/dark.svg?fit=max\u0026auto=format\u0026n=QNknRZ9DgHsEJ89b\u0026q=85\u0026s=bfb78113f781781576d974e2b10f34b9"},"favicon":"https://mintcdn.com/footstep/QNknRZ9DgHsEJ89b/favicon.svg?fit=max\u0026auto=format\u0026n=QNknRZ9DgHsEJ89b\u0026q=85\u0026s=ee0bb7e8c71620633d8dcac97b8996c9","navbar":{"links":[{"href":"https://footstep.ai/pricing","label":"Pricing"},{"href":"https://footstep.featurebase.app/","label":"Feedback"}],"primary":{"type":"button","label":"Get an API key","href":"https://console.footstep.ai"}},"footer":{"socials":{"x":"https://x.com/footstepai","github":"https://github.com/footstepai","linkedin":"https://www.linkedin.com/company/footstepai"},"links":[{"header":"Footstep","items":[{"label":"Home","href":"https://footstep.ai"},{"label":"Pricing","href":"https://footstep.ai/pricing"},{"label":"Contact","href":"https://footstep.ai/contact"}]}]},"seo":{"metatags":{"og:site_name":"Footstep","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@footstepai"}},"integrations":{"ga4":{"measurementId":"G-ZB92BQHQJ6"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"footstep","hasAudioNarration":false,"actualSubdomain":"footstep","customDomains":["docs.footstep.ai"],"gitSource":{"type":"github","owner":"footstepai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eb1bc210dbcccbc16cf7","collectionId":"bdbe2a5d-96c2-466e-a94c-2563089d3921","schemaVersion":"v2"},"feedback":{"issues":true},"entitlements":{},"buildId":"6ae946b44e1e9c8ee81a43f0:success","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"MCP Server","count":27},{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Routing","count":11},{"language":"default","tag":"Routing tools","count":9},{"language":"default","tag":"Geocoding","count":8},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Getting started","count":5},{"language":"default","tag":"Geocoding tools","count":4},{"language":"default","tag":"Natural Language","count":3},{"language":"default","tag":"Predict","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/endpoint/predict","slug":"/api/endpoint/predict","pageMetadata":{"title":"Predict","description":"Generate spatial probability predictions for behavioural profiles","openapi":"POST /v1/predict","tag":"Research Preview","href":"/api/endpoint/predict"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate spatial probability predictions for behavioural profiles\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`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 `,_jsx(_components.a,{href:`mailto:support@footstep.ai`,children:`support@footstep.ai`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`Generate spatial probability distributions for missing person scenarios. Given a last known position, a behavioural profile (age, condition, possible intent), and a search area, `,_jsx(_components.code,{children:`predict`}),` returns a probability-ranked grid covering that area — so search teams can prioritise the highest-likelihood ground.`]}),`\n`,_jsx(_components.p,{children:`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.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Predict","description":"Generate spatial probability predictions for behavioural profiles","openapi":"POST /v1/predict","tag":"Research Preview","href":"/api/endpoint/predict"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"predict","summary":"Generate spatial predictions (Research Preview)","description":"Generate spatial probability predictions for behavioural profiles","tags":["Predict"],"requestBody":"2bd5b593-859a-46d5-9889-6d7ac5fdfd7c","responses":{"200":"11f45ced-595f-4647-afa9-76cc5b7f7236","400":"40df901c-0f75-42f4-8100-4bae6682866f","503":"b59a83f8-f53f-4343-b25a-af69bf9e12e5"},"method":"post","type":"path","servers":["3de7a60e-dd5a-4a2a-8219-695a56b2b0ea"],"security":["96de8d64-7319-4c52-94c3-cf77a21b27e1"],"path":"/v1/predict","baseUrlOptions":["https://api.footstep.ai"],"title":"Generate spatial predictions (Research Preview)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profile","area","params"],"properties":{"profile":{"type":"string","enum":["despondent","dementia_alzheimers"],"description":"Behavioural profile id. Must be one of the listed values.","isRequired":true,"uniqueKey":"profile","typeLabel":"enum\u003cstring>"},"area":{"oneOf":[{"type":"object","description":"Search area — circle, polygon, or buffered path","required":["type","center","radius_m"],"properties":{"type":{"type":"string","enum":["circle"],"isRequired":true,"uniqueKey":"area.oneOf.0.type","typeLabel":"enum\u003cstring>"},"center":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"number","minimum":-90,"maximum":90,"description":"Latitude of the circle centre","isRequired":true,"uniqueKey":"area.oneOf.0.center.lat","typeLabel":"number"},"lng":{"type":"number","minimum":-180,"maximum":180,"description":"Longitude of the circle centre","isRequired":true,"uniqueKey":"area.oneOf.0.center.lng","typeLabel":"number"}},"isRequired":true,"uniqueKey":"area.oneOf.0.center","typeLabel":"object"},"radius_m":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":5000,"description":"Search radius in metres (max 5 km)","isRequired":true,"uniqueKey":"area.oneOf.0.radius_m","typeLabel":"number"}},"isRequired":true,"uniqueKey":"area.oneOf.0","typeLabel":"object"},{"type":"object","description":"Search area — circle, polygon, or buffered path","required":["type","geometry"],"properties":{"type":{"type":"string","enum":["polygon"],"isRequired":true,"uniqueKey":"area.oneOf.1.type","typeLabel":"enum\u003cstring>"},"geometry":{"type":"object","required":["type","coordinates"],"description":"GeoJSON Polygon geometry (max 25 km²)","properties":{"type":{"type":"string","enum":["Polygon"],"isRequired":true,"uniqueKey":"area.oneOf.1.geometry.type","typeLabel":"enum\u003cstring>"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","uniqueKey":"area.oneOf.1.geometry.coordinates.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number"},"minItems":2,"maxItems":2,"uniqueKey":"area.oneOf.1.geometry.coordinates.items.[INDEX].items.[INDEX]","typeLabel":"number[]"},"uniqueKey":"area.oneOf.1.geometry.coordinates.items.[INDEX]","typeLabel":"number[][]"},"isRequired":true,"uniqueKey":"area.oneOf.1.geometry.coordinates","typeLabel":"number[][][]"}},"isRequired":true,"uniqueKey":"area.oneOf.1.geometry","typeLabel":"object"}},"isRequired":true,"uniqueKey":"area.oneOf.1","typeLabel":"object"},{"type":"object","description":"Search area — circle, polygon, or buffered path","required":["type","geometry"],"properties":{"type":{"type":"string","enum":["path"],"isRequired":true,"uniqueKey":"area.oneOf.2.type","typeLabel":"enum\u003cstring>"},"geometry":{"type":"object","required":["type","coordinates"],"description":"GeoJSON LineString geometry","properties":{"type":{"type":"string","enum":["LineString"],"isRequired":true,"uniqueKey":"area.oneOf.2.geometry.type","typeLabel":"enum\u003cstring>"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","uniqueKey":"area.oneOf.2.geometry.coordinates.items.[INDEX].items.[INDEX]","typeLabel":"number"},"minItems":2,"maxItems":2,"uniqueKey":"area.oneOf.2.geometry.coordinates.items.[INDEX]","typeLabel":"number[]"},"isRequired":true,"uniqueKey":"area.oneOf.2.geometry.coordinates","typeLabel":"number[][]"}},"isRequired":true,"uniqueKey":"area.oneOf.2.geometry","typeLabel":"object"},"buffer_m":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":500,"default":50,"description":"Buffer distance in metres around the path (max 500 m). Defaults to 50 m — matches typical SAR practice for off-path search around a known route.","uniqueKey":"area.oneOf.2.buffer_m","typeLabel":"number"}},"isRequired":true,"uniqueKey":"area.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"area","typeLabel":"object"},"params":{"type":"object","required":["datetime"],"properties":{"datetime":{"type":"string","format":"date-time","description":"Date and time for the prediction (ISO 8601). Used for weather lookup and time-of-day features.","isRequired":true,"uniqueKey":"params.datetime","typeLabel":"string\u003cdate-time>"},"age_years":{"type":"number","exclusiveMinimum":true,"minimum":0,"description":"Subject age in years. Optional — omit when unknown; the model handles missing age.","uniqueKey":"params.age_years","typeLabel":"number"},"initial_bearing_deg":{"type":"number","minimum":0,"maximum":360,"description":"Initial direction of movement in degrees (0 = north, 90 = east). When provided, results are filtered to a directional cone centred on the bearing.","uniqueKey":"params.initial_bearing_deg","typeLabel":"number"},"weather":{"type":"object","required":["temperature_c","precipitation_mmh","wind_speed_mps","wind_direction_deg"],"description":"Manual weather override. When provided, the API skips the automatic weather lookup.","properties":{"temperature_c":{"type":"number","description":"Temperature in degrees Celsius","isRequired":true,"uniqueKey":"params.weather.temperature_c","typeLabel":"number"},"precipitation_mmh":{"type":"number","minimum":0,"description":"Precipitation rate in mm/hour","isRequired":true,"uniqueKey":"params.weather.precipitation_mmh","typeLabel":"number"},"wind_speed_mps":{"type":"number","minimum":0,"description":"Wind speed in metres per second","isRequired":true,"uniqueKey":"params.weather.wind_speed_mps","typeLabel":"number"},"wind_direction_deg":{"type":"number","minimum":0,"maximum":360,"description":"Wind direction in degrees (0 = north)","isRequired":true,"uniqueKey":"params.weather.wind_direction_deg","typeLabel":"number"}},"uniqueKey":"params.weather","typeLabel":"object"},"disableWeather":{"type":"boolean","default":false,"description":"Skip automatic weather fetch. When true, neutral weather defaults are used unless weather is provided manually.","uniqueKey":"params.disableWeather","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"circle":{"title":"circle","value":{"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"}}},"polygon":{"title":"polygon","value":{"profile":"despondent","area":{"type":"polygon","geometry":{"type":"Polygon","coordinates":[[[-0.13,51.5],[-0.12,51.5],[-0.12,51.51],[-0.13,51.51],[-0.13,51.5]]]}},"params":{"age_years":68,"initial_bearing_deg":90,"datetime":"2025-01-10T08:30:00Z","disableWeather":false}}},"with_weather":{"title":"with_weather","value":{"profile":"despondent","area":{"type":"circle","center":{"lat":51.5074,"lng":-0.1278},"radius_m":1000},"params":{"age_years":80,"initial_bearing_deg":0,"datetime":"2025-12-20T22:00:00Z","weather":{"temperature_c":2.5,"precipitation_mmh":0.5,"wind_speed_mps":8,"wind_direction_deg":270}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"11f45ced-595f-4647-afa9-76cc5b7f7236":{"description":"Prediction results with per-hex probabilities","content":{"application/json":{"schema":{"type":"object","required":["profile","model_version","results","summary","confidence"],"properties":{"profile":{"type":"string","description":"The profile used for this prediction","isRequired":true,"uniqueKey":"profile","typeLabel":"string"},"model_version":{"type":"string","description":"Model version that produced the prediction","isRequired":true,"uniqueKey":"model_version","typeLabel":"string"},"results":{"type":"array","description":"Per-hex predictions sorted by score (highest first)","items":{"type":"object","required":["hex","score"],"properties":{"hex":{"type":"string","description":"H3 hex index","isRequired":true,"uniqueKey":"results.items.[INDEX].hex","typeLabel":"string"},"score":{"type":"integer","minimum":0,"maximum":30,"description":"Relative confidence score (0–30). Higher = more likely.","isRequired":true,"uniqueKey":"results.items.[INDEX].score","typeLabel":"integer"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"summary":{"type":"object","required":["hex_count","processing_time_ms"],"properties":{"hex_count":{"type":"integer","description":"Number of hexagons evaluated","isRequired":true,"uniqueKey":"summary.hex_count","typeLabel":"integer"},"processing_time_ms":{"type":"number","description":"Server-side processing time in milliseconds","isRequired":true,"uniqueKey":"summary.processing_time_ms","typeLabel":"number"}},"isRequired":true,"uniqueKey":"summary","typeLabel":"object"},"confidence":{"type":"string","enum":["high","medium","low"],"description":"Model confidence level for the search area","isRequired":true,"uniqueKey":"confidence","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"profile":"\u003cstring>","model_version":"\u003cstring>","results":[{"hex":"\u003cstring>","score":15}],"summary":{"hex_count":123,"processing_time_ms":123},"confidence":"high"}}},"exampleType":"generated"}},"exampleType":"generated"},"40df901c-0f75-42f4-8100-4bae6682866f":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b59a83f8-f53f-4343-b25a-af69bf9e12e5":{"description":"Prediction engine unavailable","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"96de8d64-7319-4c52-94c3-cf77a21b27e1":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your Footstep API key","scopes":[]}}},"servers":{"3de7a60e-dd5a-4a2a-8219-695a56b2b0ea":{"url":"https://api.footstep.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your Footstep API key","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"Your Footstep API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"footstep","siteName":"Footstep","title":"Predict - Footstep","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-29T07:00:52.799Z","originalFileLocation":"api/endpoint/predict.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Generate spatial probability predictions for behavioural profiles\">\u003cmeta data-mint-head name=\"application-name\" content=\"Footstep\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Predict - Footstep\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate spatial probability predictions for behavioural profiles\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Footstep\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.footstep.ai/api/endpoint/predict\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://footstep.mintlify.app/_mintlify/api/og/v2?division=Predict\u0026amp;title=Predict\u0026amp;description=Generate+spatial+probability+predictions+for+behavioural+profiles\u0026amp;theme=3c55e5e4cb0beede006bea5a\u0026amp;signature=1f7d314c9acfaf8f84175e77f0b547b25bb91f9689d541d756d86f9c38121117\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Predict - Footstep\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate spatial probability predictions for behavioural profiles\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://footstep.mintlify.app/_mintlify/api/og/v2?division=Predict\u0026amp;title=Predict\u0026amp;description=Generate+spatial+probability+predictions+for+behavioural+profiles\u0026amp;theme=3c55e5e4cb0beede006bea5a\u0026amp;signature=1f7d314c9acfaf8f84175e77f0b547b25bb91f9689d541d756d86f9c38121117\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/footstep/qJw2BRsB8cVoVb62/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Footstep\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.footstep.ai/api/endpoint/predict\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoint/predict.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.footstep.ai/#organization\",\"name\":\"Footstep\",\"url\":\"https://docs.footstep.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/footstep/QNknRZ9DgHsEJ89b/logo/light.svg?fit=max\u0026auto=format\u0026n=QNknRZ9DgHsEJ89b\u0026q=85\u0026s=9e6862a6bf9136c6f3edc8efa1869f5d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.footstep.ai#website\",\"name\":\"Footstep\",\"url\":\"https://docs.footstep.ai\",\"publisher\":{\"@id\":\"https://docs.footstep.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.footstep.ai/api/endpoint/predict#webpage\",\"url\":\"https://docs.footstep.ai/api/endpoint/predict\",\"name\":\"Predict\",\"description\":\"Generate spatial probability predictions for behavioural profiles\",\"dateModified\":\"2026-04-29T07:00:52.799Z\",\"isPartOf\":{\"@id\":\"https://docs.footstep.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.footstep.ai/api/endpoint/predict#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.footstep.ai/api/endpoint/predict#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Predict\",\"item\":\"https://docs.footstep.ai/api/predict\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Predict\",\"item\":\"https://docs.footstep.ai/api/endpoint/predict\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.footstep.ai/api/endpoint/predict#apireference\",\"headline\":\"Predict\",\"name\":\"Predict\",\"description\":\"Generate spatial probability predictions for behavioural profiles\",\"url\":\"https://docs.footstep.ai/api/endpoint/predict\",\"mainEntityOfPage\":{\"@id\":\"https://docs.footstep.ai/api/endpoint/predict#webpage\"},\"dateModified\":\"2026-04-29T07:00:52.799Z\",\"publisher\":{\"@id\":\"https://docs.footstep.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.footstep.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Footstep\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Footstep","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/quickstart"}]},{"tab":"API reference","groups":[{"group":"Routing","pages":[{"title":"Introduction","href":"/api/routing"},{"title":"Calculate Route","openapi":"POST /v1/routing/route","href":"/api/endpoint/route"},{"title":"Optimise Route","openapi":"POST /v1/routing/optimize","href":"/api/endpoint/optimize"},{"title":"Get Elevation","openapi":"POST /v1/routing/elevation","href":"/api/endpoint/elevation"},{"title":"Calculate Isochrone","openapi":"POST /v1/routing/isochrone","href":"/api/endpoint/isochrone"},{"title":"Calculate Matrix","openapi":"POST /v1/routing/matrix","href":"/api/endpoint/matrix"},{"title":"Compare Routes","openapi":"POST /v1/routing/compare","href":"/api/endpoint/compare"},{"title":"Find and Route","openapi":"POST /v1/routing/find-and-route","href":"/api/endpoint/find-and-route"},{"title":"Search Along Route","openapi":"POST /v1/routing/search-along-route","href":"/api/endpoint/search-along-route"},{"title":"Snap GPS Trace","openapi":"POST /v1/routing/snap","href":"/api/endpoint/snap"},{"title":"Locate on Road","openapi":"POST /v1/routing/locate","href":"/api/endpoint/locate"}]},{"group":"Geocoding","pages":[{"title":"Introduction","href":"/api/geocoding"},{"title":"Search","openapi":"GET /v1/geocoding/search","href":"/api/endpoint/search"},{"title":"Structured Search","openapi":"GET /v1/geocoding/structured-search","href":"/api/endpoint/structured-search"},{"title":"Reverse Geocode","openapi":"GET /v1/geocoding/reverse","href":"/api/endpoint/reverse"},{"title":"Autocomplete","openapi":"GET /v1/geocoding/autocomplete","href":"/api/endpoint/autocomplete"},{"title":"Batch Geocode","openapi":"POST /v1/geocoding/batch","href":"/api/endpoint/batch"},{"title":"Search Places","openapi":"GET /v1/geocoding/places","href":"/api/endpoint/places"},{"title":"Parse Address","openapi":"GET /v1/geocoding/parse","href":"/api/endpoint/parse"}]},{"group":"Natural Language","pages":[{"title":"Introduction","href":"/api/ai"},{"title":"Query","openapi":"POST /v1/ai/query","href":"/api/endpoint/query"},{"title":"Parse Address","openapi":"POST /v1/ai/parse-address","href":"/api/endpoint/parse-address"}]},{"group":"Predict","pages":[{"title":"Introduction","description":"Spatial probability predictions powered by Footstep Nova","href":"/api/predict"},{"title":"Predict","openapi":"POST /v1/predict","tag":"Research Preview","href":"/api/endpoint/predict"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Predict - Footstep","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}