Yelp

Learn how to use Yelp with Composio

Overview

SLUG: YELP

Description

Yelp Fusion API provides access to business search, reviews, ratings, and local business information with rich data for location-based services

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Yelp toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Get Business Details

Description

Get detailed information about a specific business on Yelp using its business ID or alias. Returns comprehensive business information including hours, photos, reviews, and location details.

Action Parameters

business_id
stringRequired
locale

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Business Reviews

Description

Get reviews for a specific business on Yelp using its business ID or alias. Returns up to 3 review excerpts for the business.

Action Parameters

business_id
stringRequired
locale
sort_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Review Highlights

Description

Get review highlights for a specific business on Yelp using its business ID or alias. Returns summarized key points and themes from customer reviews.

Action Parameters

business_id
stringRequired
count

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search and Chat

Description

Chat with Yelp's AI assistant to search restaurants, check for availability, and make reservations.

Action Parameters

chat_id
query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Businesses

Description

Search for businesses on Yelp by location, term, categories, and other filters. This is the main search endpoint for finding businesses.

Action Parameters

attributes
categories
latitude
limit
Defaults to 20
locale
location
longitude
offset
open_at
open_now
price
radius
sort_by
term

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Business by Phone

Description

Search for a business by phone number on Yelp. This endpoint allows you to find businesses using their phone number.

Action Parameters

phone
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired