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

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["YELP"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

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
string

Action Response

data
objectRequired
error
string
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
string
sort_by
string

Action Response

data
objectRequired
error
string
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
integer

Action Response

data
objectRequired
error
string
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
string
query
stringRequired

Action Response

data
objectRequired
error
string
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
string
categories
string
latitude
number
limit
integerDefaults to 20
locale
string
location
string
longitude
number
offset
integer
open_at
integer
open_now
boolean
price
string
radius
integer
sort_by
string
term
string

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired