Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Yelp

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Yelp connection

    In AgentKit > Connections, create a Yelp connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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.actions
    const connector = 'yelp'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { 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 call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'yelp_businesses_search',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • yelp_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-only

    Ask 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-only

    Autocomplete 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-only

    Get 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-only

    Get 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-only

    Get 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-only

    List 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-only

    Match 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