X Search tool schema for fetching X posts and profiles
Example API call structure for the X Search tool, including parameters for search type, handles, and dates.
{
"tool_code": "from xai_tools.search import XSearch\nsearch = XSearch()\nsearch.search(query='[[search_query]]',
search_type='[[search_type]]', # e.g., 'keyword', 'semantic', 'user', 'thread'
allowed_x_handles=['[[handle1]]', '[[handle2]]'], # Optional, max 20
excluded_x_handles=['[[handle3]]'], # Optional, max 20
from_date='[[YYYY-MM-DD]]', # Optional
to_date='[[YYYY-MM-DD]]', # Optional
enable_image_understanding=True, # Optional
enable_video_understanding=True # Optional
)
} Language
python
Explanation
This snippet shows how to instantiate and use the XSearch tool from the xai_tools.search library. It demonstrates various parameters like query, search_type, handle filtering, date range restriction, and media understanding.
What it does and when to use it
A Python code snippet illustrating the structure of an X Search tool API call. It includes placeholders for search queries, types, handle filtering (allowed/excluded), date ranges, and enabling image/video analysis for Grok.
Sources and credit
- X Search | SpaceXAI Docs ↗xAI · xAI Docs: Guides · May 20, 2026 · paraphrased
First seen on Subvolts May 20, 2026. Updated Sep 11, 2026. Spotted a problem? Tell us.
Where it shows up
- X Search | SpaceXAI DocsxAI · xAI Docs: Guides · May 20, 2026
Related in the PlaybookPlaybook →
The Playbook: reusable how-tos, prompts, configs and tips pulled out of the news.
- Code snippetWeb Search tool configuration with domain restrictions and image featuresExample API call configuration for Grok's Web Search tool with domain filtering and image capabilities. · 10 min
- Code snippetTranscribe audio in 25 languages with batch or streaming modesTranscribe audio files or streams into text across 25 languages, supporting batch and real-time processing. · 5 min
- HeuristicEnable code execution tool for data analysis with attached filesAttach data files and enable the code execution tool for Grok to analyze and process data using Python. · 10 min
- Code snippetAPI request for multi-agent research with tools and agent countExample API call to grok-4.20-multi-agent specifying model, tools, agent count, and content encryption. · 10 min
- Setting tipUse allowed_domains to restrict Web Search to specific websitesRestrict Grok's web searches to a predefined list of domains using the allowed_domains parameter. · 5 min
- Setting tipUse excluded_domains to prevent Web Search from visiting sitesPrevent Grok's web searches from including specified domains using the excluded_domains parameter. · 5 min
Questions people ask
- Which AI tools does this work with?
- The sources used it with Grok.
- Where did this come from?
- xAI (xAI Docs: Guides). Subvolts collected, normalized and credited it; the link above opens the original.