Stream

Run a complete search in one API call and receive the results in the same response.

Endpoint

POSThttps://api.outerview.ai/v1/stream

Call this URL directly from your server with a Bearer API key. The response includes the matching observations as GeoJSON, the region scope, and a result_id; no follow-up result request is required.

cURL

curl https://api.outerview.ai/v1/stream \
  -X POST \
  -H "Authorization: Bearer $OUTERVIEW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"potholes in New York","position":{"points":[{"latitude":40.7128,"longitude":-74.006},{"latitude":40.7306,"longitude":-73.9866}]},"limit":5}'

JSON

{
  "query": "potholes in New York",
  "position": {
    "points": [
      {
        "latitude": 40.7128,
        "longitude": -74.006
      },
      {
        "latitude": 40.7306,
        "longitude": -73.9866
      }
    ]
  },
  "limit": 5
}

Field	Type	Required	Description
`query`	string	Required	Natural-language description of what to find.
`region_id`	string	Optional	Numeric region id for a precise scope.
`position`	object	Optional	Object with a points array of latitude/longitude objects. Set one position or multiple positions.
`year`	number	Optional	Restrict captures to one calendar year.
`limit`	number	Optional	Maximum returned GeoJSON features (default 50, max 50).

Response fields

The response above is a representative potholes in New York example. Only media URLs are redacted.

Field	Type	Meaning
`isSuccess`	boolean	Whether the request completed successfully.
`result_id`	string	Identifier for this search execution.
`data.query`	string	Natural-language search that was evaluated.
`data.duration_ms`	number	Server processing time in milliseconds.
`data.geojson`	FeatureCollection	Map-ready matched observations.
`features[].id / properties.id`	string	Stable observation identifier.
`geometry.type`	string	GeoJSON geometry type, typically Point.
`geometry.coordinates`	[longitude, latitude]	WGS84 map coordinates.
`address`	string \| null	Best available human-readable location.
`date`	string \| null	Capture timestamp.
`year / month`	string \| null	Capture year and month when supplied.
`source`	string \| null	Origin of the observation.
`owner`	string \| null	Source account or contributor when available.
`feature_name`	string	Artifact matched by the search.
`image_url`	string \| null	Static image URL; redacted in this example.
`is_video`	boolean \| null	Whether the capture is video.
`video_id`	string \| null	Identifier for the capture video.
`video_url`	string \| null	Video media URL; redacted in this example.
`duration`	number \| null	Video duration in seconds.
`interactive`	boolean	Whether the result opens as 360-degree media.
`regions`	array	Resolved search geography.
`year`	string \| null	Requested year filter, or null when unrestricted.

See Pagination for walking large result sets and Authentication for API key setup.