Heyyumi AI Meta API
The Meta API from Heyyumi AI — 1 operation(s) for meta.
The Meta API from Heyyumi AI — 1 operation(s) for meta.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/heyyumi-ai:heyyumi-ai-meta-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HeyYumi Meta API
version: 1.0.0
description: 'Refined food & drink venue data (the ''oneset''): identity, location, standardized hours, menu, price band, review count, freshness, confidence, plus reservation endpoints so AI can find, recommend, and book. One curator''s notebook, served as an API.
## Field Mask & tiered billing
Use the `fields` query param (comma-separated) to choose what you receive. Tokens can be tier names, `all`, or individual field names. Unknown tokens are ignored and reported via the `X-Map3-Ignored-Fields` response header. When `fields` is omitted, the default is `core`.
## Authentication
Use `Authorization: Bearer ` or the `X-API-Key` header. Do not put API keys in URLs. `?api_key=` is deprecated and scheduled for removal (it will be rejected with `401 query_auth_disabled`) because URLs are commonly stored in browser, proxy, server, and error logs.
Billing is per request: each call is billed at the highest field tier you request (returned in the `X-Map3-Units` header). `page_size` does not change tokens.
- `core` (= 1 token/request): id, name, category, categoryLabel, location, address, regionCode, confidence, sourceCount, possiblyClosed, lastSeenAt, placeUrl
- `contact_hours` (= 2 tokens/request): phone, homepage, yumiReservable, reservationChannels, snsLinks, businessHours, temporaryClosures, is24h
- `quality` (= 2 tokens/request): reviewCount, latestReviewDate, freshnessScore, dataQuality, price, menuSummary, openNow, closureSignal, promotion, photoCount, nearestStation
- `edge` (= 4 tokens/request): accessHints, recommendedFor, atmosphere, menu, serviceAttributes, dietary, atmosphereScores, aiSummary, ownerIntro, ownerStory, influencerFeatures, culturalAssociations, legacy, reputation
- `media` (= 8 tokens/request): photos
Abuse is controlled by limits, not price: per-key rate limit (requests/min) and a token cap by plan (daily on the free tier, monthly on paid plans; 429 with `Retry-After`), and a result window for the live API (100 results on the free tier, 1,000 on Starter, 5,000 on Pro and Scale). Larger or full-dataset extraction requires Bulk Export / data licensing, not paginated API calls (see Acceptable Use in the Terms).'
contact:
name: heyyumi
url: https://heyyumi.ai
servers:
- url: https://api.heyyumi.ai
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Meta
paths:
/api/v1/meta:
get:
operationId: meta
summary: Filter & field vocabulary
description: Key-free (no billing, 1h cache). Returns the supported attribute filters, values, natural-language aliases, and field tiers. The single source of truth for filter vocabulary, which MCP and SDKs sync from automatically.
parameters: []
security: []
responses:
'200':
description: OK
headers:
X-Map3-Units:
description: Billed tokens for this call = the highest field tier requested. page_size does not affect tokens (per-request billing).
schema:
type: integer
X-Map3-Ignored-Fields:
description: Comma-separated unknown field tokens that were ignored (present only when some were dropped).
schema:
type: string
content:
application/json:
example:
version: 1
filters:
boolean:
- wifi
- parking
- outdoor_seating
- pet_friendly
- group_friendly
- kids_friendly
- reservable
- takeout
- delivery
- dine_in
- catering
- corkage_free
- corkage_available
- wheelchair_accessible
- high_chair
- no_kids_zone
- smoking_area
- restroom_gender_separated
- power_outlets
- stroller_storage
- deposit_required
- restroom_clean
- waiting_expected
- leftover_packing
- repeat_customers
- private_room
- has_promotion
- real_bar
- english_menu
- foreigner_friendly
- good_value
- rooftop
- hanok
- photo_spot
- local_favorite
- nursing_room
- live_music
- fireplace
- floor_seating
- counter_seating
- inside_market
- board_game
- sports_bar
- temple_food
- natural_wine
- craft_beer
- omakase
- unlimited_refill
- charcoal_grill
- domestic_ingredients
- traditional_liquor
- kids_play_area
- fine_dining
- michelin_star
enum:
parking_type:
- onsite
- valet
- partner
- nearby
- none
subtype:
- cocktail_bar
- whisky_bar
- wine_bar
- bar_generic
- izakaya
- pocha
- hof_beer
- korean_pub
- coffee
- dessert
- bakery
- ice_cream
- brunch
- tea
- traditional_tea
- juice_fruit
- themed
- korean
- korean_bbq
- gopchang
- jokbal_bossam
- chicken
- chinese
- japanese
- sushi_sashimi
- western
- italian
- vietnamese
- asian
- noodles
- bunsik
- burger
- gukbap_soup
- jjigae
- shabu
- seafood
- salad_healthy
- sandwich_deli
- lunchbox
- buffet
bbq_meat:
- pork
- beef
- duck
- lamb
view:
- ocean
- sunset
- river
- mountain
- night
- city
- garden
reservationChannel:
- yumi
- phone
array:
payment_methods:
- cash
- card
- toss_pay
- kakao_pay
- naver_pay
- zero_pay
- local_gift
- gov_support
- alipay
- wechat_pay
- apple_pay
- samsung_pay
- unionpay
serves:
- coffee
- alcohol
- dessert
- vegetarian
- vegan
dietary:
- vegan_options
- vegetarian_options
- fully_vegan
- mixed_group_suitable
- vegetarian_mixed_group_suitable
- gluten_free
foreign_languages:
- en
- zh
- ja
- es
- de
- fr
recommended_for:
- solo_dining
- solo_drinking
- date
- group_dining
- group_drinking
- family
- business_meeting
- formal_gathering
- late_night
- late_night_eatery
atmosphere:
- cozy
- quiet
- lively
- spacious
- view
- trendy
- traditional
- clean
- work_study
- rainy_mood
aliases:
recommended_for:
회식: group_dining
혼밥: solo_dining
상견례: formal_gathering
atmosphere:
조용한: quiet
뷰맛집: view
parking_type:
발렛: valet
foreign_languages:
영어: en
일본어: ja
subtype:
삼겹살: korean_bbq
국밥: gukbap_soup
칵테일바: cocktail_bar
bbq_meat:
삼겹살: pork
한우: beef
오리: duck
view:
바다뷰: ocean
한강뷰: river
야경: night
dietary:
비건: vegan_options
글루텐프리: gluten_free
fields:
tiers:
core: 1
contact_hours: 2
quality: 2
edge: 4
media: 8
byField:
name: core
temporaryClosures: contact_hours
reviewCount: quality
serviceAttributes: edge
influencerFeatures: edge
photos: media
coverage:
supported:
- 서울
- 경기
- 부산
- 제주
- 인천
- 대전
- 세종
- 충북
- 충남
note: 현재 서울·경기·부산·제주·인천·대전·세종·충남·충북 9개 시/도를 공식 제공(coverage 확대 중). 그 밖 지역(대구·광주·강원 등)은 결과가 비면 '아직 미지원'으로 안내.
'400':
description: Invalid parameters / bulk_export_required (result window too large)
'401':
description: API key required or invalid
'429':
description: Rate limit, daily quota, or monthly quota exceeded (see Retry-After)
tags:
- Meta
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'Preferred: Authorization: Bearer <API_KEY>. Do not pass keys in URLs.'
apiKeyHeader:
type: apiKey
in: header
name: X-API-Key
description: Alternative header auth. Query-string api_key is deprecated.