The Yelp connector lets your AI agent act in each user's Yelp account. Each user connects their own Yelp access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 15 tools.
- Tools
- 15
- What they doRead · write · destructive
- 15 · 0 · 015 read0 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Yelp connection
In AgentKit > Connections, create a Yelp connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'yelp'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Yelp:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'yelp_businesses_search',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "yelp"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Yelp:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="yelp_businesses_search",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Yelp credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolyelp_ai_chat_sendAsk the Yelp AI API a natural-language question about local businesses, such as "vegan pizza near me that is open late", and keep a multi-turn conversation.Read-onlyAsk Yelp AI
Ask the Yelp AI API a natural-language question about local businesses, such as "vegan pizza near me that is open late", and keep a multi-turn conversation. Returns a text answer with tags that point to businesses in it, the matching businesses as structured data (id, name, rating, location, summaries and more), the response types and a chat_id. Use this for conversational or open-ended questions. Pass the returned chat_id on follow-up questions to keep context. Use yelp_businesses_search for structured filters and paging.
Inputs
querystringrequired- The user's question in plain natural language. Example: What's a good vegan pizza place near me?
chat_idstring- Conversation ID returned by a previous call. Leave empty to start a new conversation; pass it to ask a follow-up in the same conversation. An invalid ID makes the request fail. Example: 7ac95mkCJBR9WVPfpf3R_w
latitudenumber- User's approximate latitude, from -90 to 90, so location-based answers are local. Give it with longitude. Example: 40.7128
localestring- User's locale, as language code and country code joined by an underscore. Example: en_US
longitudenumber- User's approximate longitude, from -180 to 180, so location-based answers are local. Give it with latitude. Example: -74.006
skip_text_generationboolean- Set to true to skip the generated text answer and return only structured data (businesses, entities, types). This lowers latency. Defaults to false.
yelp_autocomplete_suggestions_listSuggest search terms, businesses and categories that complete partial text, for type-ahead search.Read-onlyAutocomplete Search Text
Suggest search terms, businesses and categories that complete partial text, for type-ahead search. Returns three lists: terms (text), businesses (id and name) and categories (alias and title). Use this while a user is still typing or to turn a vague word into a category alias. Use yelp_businesses_search to run the actual search.
Inputs
textstringrequired- Text to complete. Example: del
latitudenumber- Latitude to rank business suggestions around, from -90 to 90. Give it with longitude to get business suggestions. Example: 37.786942
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
longitudenumber- Longitude to rank business suggestions around, from -180 to 180. Give it with latitude to get business suggestions. Example: -122.399643
yelp_business_engagement_getGet Yelp engagement metrics, such as page views and leads, for up to 20 businesses over a date range.Read-onlyGet Business Engagement Metrics
Get Yelp engagement metrics, such as page views and leads, for up to 20 businesses over a date range. Returns, for each business, its engagement metrics for the requested period (by default the most recent available week). Use this for analytics on how users interact with business listings. Use yelp_business_get for the business profile. Requires special permission on the API key (part of Yelp Insights).
Inputs
business_idsarrayrequired- Yelp business IDs or aliases to get metrics for, at most 20. Get IDs from yelp_businesses_search or yelp_businesses_match. Example: ["WavvLdfdP6g8aZTtbBQHTw", "gary-danko-san-francisco"]
date_range_endstring- Last day of the period, as YYYY-MM-DD. Defaults to the end of the most recent available week. Example: 2026-10-31
date_range_startstring- First day of the period, as YYYY-MM-DD. Defaults to the start of the most recent available week. Example: 2026-10-01
yelp_business_getGet the full Yelp profile of one business by its ID or alias.Read-onlyGet Business Details
Get the full Yelp profile of one business by its ID or alias. Returns name, rating, review_count, price, categories, location, coordinates, phone, opening hours, is_closed, transactions, photos (on plans that include them), attributes and url. Use this after a search or match to read one business in detail. Use yelp_business_reviews_list for its review excerpts and yelp_business_review_highlights_get for highlighted phrases.
Inputs
business_id_or_aliasstringrequired- The business's 22-character Yelp ID or its Yelp alias (the last part of its yelp.com/biz/ URL). Get it from yelp_businesses_search, yelp_businesses_search_by_phone, yelp_businesses_match or yelp_autocomplete_suggestions_list. Example: WavvLdfdP6g8aZTtbBQHTw
device_platformstring- Platform to build each business's mobile_link for: android, ios or mobile-generic. Leave empty if you do not need a mobile deep link. Example: iosone of
androidiosmobile-generic localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
yelp_business_review_highlights_getGet review highlights for one Yelp business: short phrases that many reviewers mention.Read-onlyGet Review Highlights
Get review highlights for one Yelp business: short phrases that many reviewers mention. Returns up to 5 highlights, each with the sentence, the highlighted phrase and how many reviews mention it. Use this for a quick summary of what people praise or mention. Use yelp_business_reviews_list for review excerpts with ratings. Requires the Premium API plan.
Inputs
business_id_or_aliasstringrequired- The business's 22-character Yelp ID or its Yelp alias (the last part of its yelp.com/biz/ URL). Get it from yelp_businesses_search, yelp_businesses_search_by_phone, yelp_businesses_match or yelp_autocomplete_suggestions_list. Example: WavvLdfdP6g8aZTtbBQHTw
countinteger- Number of highlights to return, at most 5. Defaults to 3. Example: 5
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
yelp_business_reviews_listList review excerpts for one Yelp business, in Yelp's default order.Read-onlyList Business Reviews
List review excerpts for one Yelp business, in Yelp's default order. Returns reviews with id, rating, text (an excerpt of up to 160 characters), time_created, url and the reviewer's name and profile, plus the total review count. How many reviews come back depends on the API plan. Use this to read what reviewers say about a business. Use yelp_business_review_highlights_get for short highlighted phrases instead, and yelp_business_get for the business profile.
Inputs
business_id_or_aliasstringrequired- The business's 22-character Yelp ID or its Yelp alias (the last part of its yelp.com/biz/ URL). Get it from yelp_businesses_search, yelp_businesses_search_by_phone, yelp_businesses_match or yelp_autocomplete_suggestions_list. Example: WavvLdfdP6g8aZTtbBQHTw
limitinteger- Number of reviews to return, from 0 to 50. Defaults to 20, but the API plan caps how many are returned (none on Base, up to 3 on Enhanced, up to 7 on Premium). Example: 3
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
offsetinteger- Number of reviews to skip, for paging, from 0 to 1000. Example: 20
sort_bystring- Review order. Only yelp_sort (Yelp's default order) is supported. Example: yelp_sortone of
yelp_sort
yelp_businesses_matchMatch a business you know from another source (name and full address) to its Yelp listing.Read-onlyMatch Business
Match a business you know from another source (name and full address) to its Yelp listing. Returns up to 10 candidate businesses with id, alias, name, location and coordinates; by default only very close matches are returned. Use this to find the Yelp ID of a specific known business. Use yelp_businesses_search when you only know a name and a general area, and yelp_businesses_search_by_phone when you only have a phone number. Then use yelp_business_get for details.
Inputs
address1stringrequired- First line of the street address. Only letters, digits, spaces and '/#&,.: are allowed. For a service business with no street address, use yelp_businesses_search or yelp_businesses_search_by_phone instead. Example: 800 N Point St
citystringrequired- City of the business. Only letters, digits, spaces and '.() are allowed. Example: San Francisco
countrystringrequired- Two-letter ISO 3166-1 alpha-2 country code of the business. Example: US
namestringrequired- Business name. Only letters, digits, spaces and !#$%&+,./:?@' are allowed. Example: Gary Danko
statestringrequired- State, province or region code in ISO 3166-2 form (without the country prefix), with a few Yelp exceptions listed at https://docs.developer.yelp.com/docs/resources-state-codes. Example: CA
address2string- Second line of the street address, such as a suite or unit. Example: Suite 200
address3string- Third line of the street address. Example: Building B
latitudenumber- Latitude of the business, from -90 to 90, as a matching hint. Give it with longitude. Example: 37.80587
limitinteger- Maximum number of matches to return, from 1 to 10. Defaults to 3. Example: 3
longitudenumber- Longitude of the business, from -180 to 180, as a matching hint. Give it with latitude. Example: -122.42058
match_thresholdstring- How strict the match must be: default returns only very close matches, strict is stricter still, and none returns every possible match. Example: defaultone of
nonedefaultstrict phonestring- Business phone number, either local digits only (016703080) or international with a leading + (+35316703080). Example: +14157492060
postal_codestring- ZIP or postal code of the business. Example: 94109
yelp_business_idstring- Yelp business ID, if you already have a guess, used as a hint for the match. Example: WavvLdfdP6g8aZTtbBQHTw
yelp_businesses_searchSearch Yelp businesses near a location by term, category, price, open hours and attributes.Read-onlySearch Businesses
Search Yelp businesses near a location by term, category, price, open hours and attributes. Returns up to 50 businesses per page (240 in total) with id, alias, name, rating, review_count, price, categories, coordinates, location, phone, distance and url, plus the total match count. Use this to discover businesses from general criteria. Use yelp_businesses_match when you know a business's exact name and address, yelp_businesses_search_by_phone when you only have a phone number, yelp_delivery_businesses_search for food delivery, and yelp_ai_chat_send for a natural-language question.
Inputs
attributesstring- Comma-separated attribute filters; a business must have all of them. Available on every plan: hot_and_new, request_a_quote, reservation, waitlist_reservation, gender_neutral_restrooms, open_to_all, wheelchair_accessible. The Premium plan adds filters such as accepts_credit_cards, dogs_allowed, good_for_dancing, happy_hour, outdoor_seating, restaurants_delivery, restaurants_takeout, wifi_free, parking_lot, noise_level_quiet, ambience_romantic and liked_by_vegetarians. Example: hot_and_new,reservation
categoriesstring- Comma-separated Yelp category aliases to filter by; a business matching any of them is returned. Use the alias, not the title (discgolf, not Disc Golf); yelp_categories_list lists them. Example: bars,french
device_platformstring- Platform to build each business's mobile_link for: android, ios or mobile-generic. Leave empty if you do not need a mobile deep link. Example: iosone of
androidiosmobile-generic latitudenumber- Latitude of the point to search around, from -90 to 90. Required with longitude when location is not given. Example: 37.7867
limitinteger- Number of businesses to return, from 0 to 50. Defaults to 20. Example: 10
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
locationstring- Address, neighborhood, city, ZIP code or other place to search for businesses in. Required unless latitude and longitude are given. Results may fall slightly outside the area. Example: 350 5th Ave, New York, NY 10118
longitudenumber- Longitude of the point to search around, from -180 to 180. Required with latitude when location is not given. Example: -122.4112
matches_party_size_paramboolean- Set to true to leave out businesses without an opening that matches the reservation date, time and party size.
offsetinteger- Number of businesses to skip, for paging, from 0 to 1000. Example: 20
open_atinteger- Unix timestamp, in the search location's time zone, at which the businesses must be open. Do not combine with open_now. Example: 1735732800
open_nowboolean- Set to true to return only businesses that are open now. Do not combine with open_at.
pricestring- Comma-separated price levels to filter by, where 1 = $, 2 = $$, 3 = $$$ and 4 = $$$$. A business matching any listed level is returned. Example: 1,2
radiusinteger- Suggested search radius in meters, up to 40000 (about 25 miles). Yelp may use a smaller radius in dense areas and a larger one in sparse areas. Example: 1600
reservation_coversinteger- Number of people in the reservation, from 1 to 10. Example: 4
reservation_datestring- Date to check reservation availability for, as YYYY-MM-DD. Use with reservation_time and reservation_covers. Example: 2026-12-24
reservation_timestring- Time to check reservation availability for, as HH:MM in 24-hour time. Example: 19:30
sort_bystring- Suggested order of results: best_match (default), rating, review_count or distance. Yelp treats it as a hint; the rating sort weighs the number of reviews too. Example: ratingone of
best_matchratingreview_countdistance termstring- Search term, such as a kind of business (food, plumbers) or a business name (Starbucks). When empty, Yelp searches a few popular categories. Example: tacos
yelp_businesses_search_by_phoneFind Yelp businesses that use a given phone number.Read-onlySearch Businesses by Phone
Find Yelp businesses that use a given phone number. Returns the matching businesses (more than one when, for example, a chain shares a number) with id, alias, name, rating, review_count, categories, location and url. Use this when a phone number is all you have. Use yelp_businesses_match when you also know the name and address, and yelp_businesses_search for criteria such as a term and location.
Inputs
phonestringrequired- Business phone number in international format: a leading + and the country code, digits only. Example: +14159083801
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
yelp_categories_listList all Yelp business categories, optionally only those used in one locale.Read-onlyList Categories
List all Yelp business categories, optionally only those used in one locale. Returns categories with alias, title, parent_aliases, country_whitelist and country_blacklist. Use this to find the category alias to pass to search tools. Use yelp_category_get for one category by alias.
Inputs
localestring- Locale to filter the categories to, and to translate their titles into. Without it, all categories across all locales are returned with English titles. Example: fr_FR
yelp_category_getGet one Yelp business category by its alias.Read-onlyGet Category
Get one Yelp business category by its alias. Returns the category's alias, title, parent_aliases, country_whitelist and country_blacklist. Use this to check a category's parents or the countries it applies to. Use yelp_categories_list to browse all categories.
Inputs
aliasstringrequired- Category alias, from yelp_categories_list or https://docs.developer.yelp.com/docs/resources-categories. Example: hotdogs
localestring- Locale to translate the category title into. Example: fr_FR
yelp_delivery_businesses_searchSearch US businesses that offer food delivery through Yelp near a location.Read-onlySearch Food Delivery Businesses
Search US businesses that offer food delivery through Yelp near a location. Returns businesses with id, alias, name, rating, review_count, price, categories, location, phone, transactions and url, plus the total count. Use this when the user wants food delivered. Use yelp_businesses_search for general business discovery with more filters. Only the United States is supported.
Inputs
categoriesstring- Comma-separated Yelp category aliases to filter by; a business matching any of them is returned. Use the alias, not the title (discgolf, not Disc Golf); yelp_categories_list lists them. Example: bars,french
latitudenumber- Latitude of the point to search around, from -90 to 90. Required with longitude when location is not given. Example: 37.7867
locationstring- Address, neighborhood, city, ZIP code or other place to search for delivery businesses in. Required unless latitude and longitude are given. Results may fall slightly outside the area. Example: 350 5th Ave, New York, NY 10118
longitudenumber- Longitude of the point to search around, from -180 to 180. Required with latitude when location is not given. Example: -122.4112
pricestring- Comma-separated price levels to filter by, where 1 = $, 2 = $$, 3 = $$$ and 4 = $$$$. A business matching any listed level is returned. Example: 1,2
termstring- Search term, such as a kind of business (food, plumbers) or a business name (Starbucks). When empty, Yelp searches a few popular categories. Example: tacos
yelp_event_getGet the details of one Yelp event by its ID.Read-onlyGet Event Details
Get the details of one Yelp event by its ID. Returns name, description, time_start, time_end, cost, cost_max, is_free, category, attending_count, interested_count, image_url, location, business_id, event_site_url and tickets_url. Use this after yelp_events_search or yelp_featured_event_get to read one event in full.
Inputs
event_idstringrequired- Yelp event ID, from yelp_events_search or yelp_featured_event_get. Example: oakland-saucy-oakland-restaurant-pop-up
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
yelp_events_searchSearch Yelp events near a location, filtered by time, category and price.Read-onlySearch Events
Search Yelp events near a location, filtered by time, category and price. Returns events with id, name, description, time_start, time_end, cost, is_free, category, attending_count, location, event_site_url and tickets_url, plus the total count. Use this to find what is happening in an area. Use yelp_featured_event_get for the one featured event Yelp's community managers picked, and yelp_event_get for one event by ID.
Inputs
categoriesstring- Comma-separated event category aliases, such as music, food-and-drink, nightlife, sports-active-life, visual-arts, performing-arts, festivals-fairs, film, kids-family, lectures-books, fashion, charities, other. Example: music,nightlife
end_dateinteger- Unix timestamp; only events that end at or before this time are returned. Example: 1736294400
excluded_eventsstring- Comma-separated event IDs to leave out of the results. Example: oakland-saucy-oakland-restaurant-pop-up
is_freeboolean- Set to true for free events only, or false for paid events only. Leave empty for both.
latitudenumber- Latitude of the point to search around, from -90 to 90. Required with longitude when location is not given. Example: 37.7867
limitinteger- Number of events to return, from 0 to 50. Defaults to 3. Example: 10
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
locationstring- Address, neighborhood, city, ZIP code or other place to search for events in. Required unless latitude and longitude are given. Results may fall slightly outside the area. Example: 350 5th Ave, New York, NY 10118
longitudenumber- Longitude of the point to search around, from -180 to 180. Required with latitude when location is not given. Example: -122.4112
offsetinteger- Number of events to skip, for paging, from 0 to 1000. Example: 20
radiusinteger- Search radius in meters, up to 40000 (about 25 miles). Example: 5000
sort_bystring- Sort direction: desc (default) or asc. Example: ascone of
ascdesc sort_onstring- Field to sort on: popularity (default) or time_start. Example: time_startone of
popularitytime_start start_dateinteger- Unix timestamp; only events that start at or after this time are returned. Example: 1735689600
yelp_featured_event_getGet the featured event for a location, picked by Yelp's community managers.Read-onlyGet Featured Event
Get the featured event for a location, picked by Yelp's community managers. Returns one event with id, name, description, time_start, time_end, cost, is_free, category, location, event_site_url and tickets_url. Use this for a single curated suggestion. Use yelp_events_search to list and filter events.
Inputs
latitudenumber- Latitude of the point to search around, from -90 to 90. Required with longitude when location is not given. Example: 37.7867
localestring- Locale for the response text, as language code and country code joined by an underscore. Defaults to en_US. Supported locales: https://docs.developer.yelp.com/docs/resources-supported-locales. Example: fr_FR
locationstring- Address, neighborhood, city, ZIP code or other place to search for the featured event in. Required unless latitude and longitude are given. Results may fall slightly outside the area. Example: 350 5th Ave, New York, NY 10118
longitudenumber- Longitude of the point to search around, from -180 to 180. Required with latitude when location is not given. Example: -122.4112
No tools match.