Search places — AgentSky

Search places

Overview

Searches for places from an ordinary text query such as a cuisine, business name, or category with a location, and returns matching places with their identifiers, names, and addresses. Results can be biased toward a circle or rectangle, which prefers nearby places without excluding others, or narrowed by place type, minimum rating, price level, and whether the business is open now. Ranking is selectable between relevance and distance, and results page up to sixty in total.

A list of places with their id, display name, and formatted address, plus a page token when more remain.

Input

These go in the input object of the run request.

Field Type Required Description
textQuery string Yes What to search for, including the place or area.
pageSize integer No How many places to return per page.
Default: 20
Minimum: 1
Maximum: 20
includedType string No Restrict results to a single place type.
openNow boolean No Only return places open at the time of the request.
minRating number No Lowest average rating to accept.
Minimum: 0
Maximum: 5
locationBias object No A circle or rectangle to prefer results near.
languageCode string No Language of the returned place names.

Requests up to 1 MB.

Example

Use your own API key and a saved idempotency key for each new job. Replace image or media placeholders with your own publicly reachable HTTPS URLs. Keep the same key and request body when recovering a timeout.

# Set once per job; reuse this key and the identical body after a timeout.
: "${AGENTSKY_IDEMPOTENCY_KEY:?Set a unique, saved key for this job}"
curl --fail-with-body https://gateway.agentsky.dev/v1/run \ 
  -H "authorization: Bearer $AGENTSKY_API_KEY" \ 
  -H "content-type: application/json" \ 
  -H "Idempotency-Key: $AGENTSKY_IDEMPOTENCY_KEY" \ 
  -d '{"provider":"googlemap","endpoint":"places","input":{"textQuery":"coffee in Sydney, Australia","pageSize":10,"languageCode":"en"}}'
# If status is READY/RUNNING, poll GET /v1/runs/{runId} with the same API key.

Pricing

$0.0384 per call using your plan when signed in. Read the final customer charge from price.amount.value after the run finishes. A RUNNING response is not the final bill.

Questions

What does Search places do?

How much does Search places cost?

What does Search places take?

What are the limits on Search places?

How do I retry safely and check the final charge?