Connect
API
Pull Yumi's verified venue data straight into your product or backend over REST. Get a key → add it to your header → first call.
Issue your API key in the dashboard. The plaintext key is shown only once at creation — store it safely.
Get an API key →- 01
Create a key
Make an API key in the dashboard. The plaintext key is shown only once.
- 02
Send the key
Add Authorization: Bearer <KEY> to every request. (Avoid ?api_key= in the URL — it's easy to log and is deprecated.)
- 03
First call
Search /api/v1/places. Each call meters tokens precisely; exceeding your quota returns 429.
example
curl -H "Authorization: Bearer YOUR_KEY" \ "https://api.heyyumi.ai/api/v1/places?keyword=burger&min_confidence=0.7"
How much does a call use?
You only spend tokens for the fields you choose. Calls default to the lightest tier (core), so they cost little — you use more only when you deliberately ask for richer fields like contact, rating, or details. Cost tracks the fields you pick, so it stays predictable. During Open Season personal use is free — up to 70 tokens a day. For commercial or high-volume use, or a bigger quota, get in touch.
Commercial / high-volume? Contact us →