Skip to main content
Add these tools with AgentTools.<tool>(tool_name="...", ...) or agent.add_tool.<tool>(tool_name="...", ...). Every tool requires a unique tool_name=. Each entry lists the tool’s configuration parameters. See the Agent reference for attaching and running tools.

api

Make an API request to a given URL.
Platform docs: API
AgentTools.api(tool_name="...", is_raw_json=True, url="...")
Parameters
is_raw_json
bool
required
Whether to return the raw JSON response from the API
url
str
required
Target URL for the API Request
body_params
list[Dict[str, Any]]
The body parameters to include in the API request
files
list[Dict[str, Any]]
Files to include in the API request
headers
list[Dict[str, Any]]
Headers to include in the API request
method
str
Choose the API Method desired (GET, POST, PUT, DELETE, PATCH)
query_params
list[Dict[str, Any]]
Query parameters to include in the API request
raw_json
str
The raw JSON request to the API

arxiv

Query ARXIV to return relevant articles
Platform docs: Arxiv Loader
AgentTools.arxiv(tool_name="...", chunk_text=True, query="...")
Parameters
chunk_text
bool
required
Whether to chunk the text
query
str
required
The ARXIV query
chunk_overlap
int
The overlap of the chunks
chunk_size
int
The size of the chunks to create

crunchbase

Call the Crunchbase API to look up companies, people, funding rounds, and acquisitions.
Platform docs: Crunchbase
AgentTools.crunchbase(tool_name="...")
Parameters
body
Any
JSON body for searches/* endpoints. IMPORTANT: categories and location_identifiers require UUIDs from autocomplete, not text! Example: {“field_ids”:[“identifier”,“funding_total”],“query”:[{“type”:“predicate”,“field_id”:“categories”,“operator_id”:“includes”,“values”:[“uuid-from-autocomplete”]}],“limit”:25}
endpoint
Any
API path: ‘autocompletes’ | ‘entities/organizations/{id}’ | ‘entities/people/{id}’ | ‘searches/organizations’ | ‘searches/funding_rounds’ | ‘searches/people’
query_params
Any
Query string for GET requests. Autocomplete: ‘query={name}&collection_ids=organization.companies’. Entity lookup: ‘field_ids=short_description,funding_total&card_ids=founders’

exa_ai

Query the Exa search API
Platform docs: Exa AI Search
AgentTools.exa_ai(tool_name="...")
Parameters
end_crawl_date
Any
Only return results crawled before this date (ISO 8601)
end_published_date
Any
Only return results published before this date (ISO 8601, e.g. 2024-12-31T00:00:00.000Z)
livecrawl
Any
Enable live crawling to fetch fresh content. When on, always fetches live content. When off, uses cached content.
loader_type
str
default:"'EXA_AI_SEARCH'"
Select the search category to match the user’s query intent. Default to EXA_AI_SEARCH: General web search. Use general search for weather
max_characters
int
default:"2000"
Maximum characters per result for text or highlights content
num_results
int
default:"10"
Number of results to return (1-100) default 10
query
str
default:"''"
The search query
search_type
Any
Search method: auto (default) intelligently combines methods, neural uses embeddings, fast is streamlined, instant is lowest latency, deep/deep-reasoning/deep-max offer increasing search depth, Generally default to auto
start_crawl_date
Any
Only return results crawled after this date (ISO 8601)
start_published_date
Any
Only return results published after this date (ISO 8601, e.g. 2024-01-01T00:00:00.000Z)
use_highlights
bool
default:"False"
Return LLM-selected highlights instead of full text. Uses ~10x fewer tokens with better relevance.
Query the Google Search search API
Platform docs: Google Search
AgentTools.google_search(tool_name="...")
Parameters
location
str
default:"'us'"
The location of the search
num_results
int
default:"10"
The number of results to return
query
str
default:"''"
The Google search query
search_type
str
default:"'web'"
Select the search type: Web, Image, Hotels, Events, or News
Search the web with Parallel’s Search API
Platform docs: Parallel Search
AgentTools.parallel_ai_search(tool_name="...")
Parameters
blocked_domains
list[str]
default:"[]"
Exclude these domains from the response.
excerpts_max_chars_per_result
int
default:"1500"
Limit the excerpt length returned inside the excerpts object.
fetch_live_results
bool
default:"False"
Enable to fetch the latest version of each page instead of relying on cached index entries.
max_chars_per_result
int
default:"1500"
Legacy field for truncating excerpts. Prefer the excerpts.* controls when available.
max_results
int
default:"10"
Upper bound on the number of results to return.
mode
str
default:"'one-shot'"
Choose output presets. one-shot maximizes coverage, agentic optimizes for iterative agent loops.
objective
str
default:"''"
Describe what the search should accomplish. Provide preferred sources or freshness hints here.
preferred_domains
list[str]
default:"[]"
Prioritize these domains in ranked results.
processor
str
default:"''"
Legacy tier selector. Leave blank to use the default tier for your workspace.
search_queries
list[str]
default:"[]"
Optional structured keyword queries. At least one of objective or search queries is required.
Query the Perplexity search API
Platform docs: Perplexity Search
AgentTools.perplexity_search(tool_name="...")
Parameters
last_updated_after_filter
str
default:"''"
Filter results last updated after this date
last_updated_before_filter
str
default:"''"
Filter results last updated before this date
max_results
int
default:"10"
The maximum number of results to return
max_tokens_per_page
Any
Maximum tokens per page
query
str
default:"''"
The search query
query_list
list[str]
default:"[]"
Additional queries to search for
return_images
bool
default:"False"
Whether to return images in results
return_snippets
bool
default:"True"
Whether to return snippets in results
search_after_date_filter
str
default:"''"
Filter results published after this date
search_before_date_filter
str
default:"''"
Filter results published before this date
search_domain_filter
list[str]
default:"[]"
Filter results to specific domains
search_mode
str
default:"''"
The search mode to use
search_recency_filter
str
default:"''"
Filter results by recency
user_location_latitude
str
default:"''"
The latitude of the user’s location
user_location_longitude
str
default:"''"
The longitude of the user’s location
user_location_name
str
default:"''"
The name of the user’s location
user_location_radius_km
str
default:"''"
The radius in kilometers for location-based search

url_loader

Scrape the contents from a URL
AgentTools.url_loader(tool_name="...", provider="apify", api_key="...", url="...")
Parameters
provider
str
required
The provider to use for the URL Scraper One of: apify, jina, modal
api_key
str
required
The API key to use
url
str
required
The URL to load
ai_enhance_content
bool
Whether to enhance the content
use_proxy
bool
Use a proxy to crawl the website

wikipedia

Query Wikipedia to return relevant articles
Platform docs: Get Wikipedia Article
AgentTools.wikipedia(tool_name="...", chunk_text=True, query="...")
Parameters
chunk_text
bool
required
Whether to chunk the text
query
str
required
The Wikipedia query
chunk_overlap
int
The overlap of the chunks
chunk_size
int
The size of the chunks to create

youtube

Get the transcript of a youtube video.
Platform docs: Get YouTube Transcript
AgentTools.youtube(tool_name="...", chunk_text=True, url="...")
Parameters
chunk_text
bool
required
Whether to chunk the text
url
str
required
The YouTube URL to get the transcript of
chunk_overlap
int
The overlap of the chunks
chunk_size
int
The size of the chunks to create