you.com web search, deep research, and content extraction for OpenClaw. Free tier for basic search; research and extract require paid API key.
---
name: youcom-search
description: you.com web search, deep research, and content extraction for OpenClaw. Free tier for basic search; research and extract require paid API key.
version: 0.1.4
triggers:
- "you.com"
- "youcom"
- "search the web"
- "look up"
- "youcom web search"
- "web search"
- "deep research"
- "extract content"
- "read this page"
permissions:
network:
- api.you.com
- ydc-index.io
env:
- YOUCOM_API_KEY
file:
- write: optional, only when --out flag is supplied
shell: none
metadata:
clawdbot:
emoji: "π"
requires:
bins: [python3]
config:
env:
YOUCOM_API_KEY:
description: "API key for you.com research and extract endpoints"
required: true
---
# you.com Web Search
Free web search, deep research, and content extraction β no mandatory API key for basic search.
## Tools
| Need | Tool | Cost | API Key |
|------|------|------|---------|
| General web search | `youcom_search` | Free | β |
| Deep research with citations | `youcom_research` | Paid | β
|
| Extract content from URLs | `youcom_extract` | Paid | β
|
## Quick Start
### Free Search (no setup)
```bash
python3 scripts/youcom_search.py "search query" --num 5
```
### Research / Extract (requires API key)
```bash
export YOUCOM_API_KEY="your_key"
python3 scripts/youcom_research.py "topic" --depth deep
python3 scripts/youcom_extract.py https://example.com/article
```
## Setup
### Free Search
No setup required β `youcom_search` works immediately.
### Research & Extract (Paid)
1. Get an API key at [you.com/platform/api-keys](https://you.com/platform/api-keys)
2. Add to `~/.openclaw/.env`:
```
YOUCOM_API_KEY=your_key_here
```
3. Restart the gateway: `systemctl --user restart openclaw-gateway`
## youcom_search β Free Web Search
Use for all general web searches. No API key needed.
```bash
python3 scripts/youcom_search.py "query" [--num N]
```
| Option | Description |
|--------|-------------|
| `query` | Search term (required) |
| `--num`, `-n` | Results to return, 1β10 (default: 5) |
| `--out`, `-o` | Write JSON to file instead of stdout |
**Output:** JSON with `query`, `count`, and `results[]` (title, url, description, snippets).
**Tips:**
- Supports search operators: `site:reddit.com`, `filetype:pdf`, `time:week`
- Results include social snippets when available
- Uses python3 `urllib` β no external dependencies
## youcom_research β Deep Research (Paid)
Synthesized answer with citations. Requires `YOUCOM_API_KEY`.
```bash
python3 scripts/youcom_research.py "topic" [--depth lite|standard|deep|exhaustive]
```
| Option | Description |
|--------|-------------|
| `query` | Research topic (required) |
| `--depth`, `-d` | lite, standard (default), deep, exhaustive |
**β οΈ Always confirm cost with user before using paid endpoints.**
## youcom_extract β Content Extraction (Paid)
Extract clean text from specific URLs. Requires `YOUCOM_API_KEY`.
```bash
python3 scripts/youcom_extract.py <url> [<url>...] [--formats markdown html metadata] [--timeout 10]
```
| Option | Description |
|--------|-------------|
| `urls` | One or more URLs (space-separated) |
| `--formats`, `-f` | Output formats: markdown, html, metadata (default: markdown metadata) |
| `--timeout`, `-t` | Crawl timeout per URL in seconds 1β60 (default: 10) |
**Max 20 URLs per call.** Batch larger lists into multiple calls.
## When to Use What
| Need | Tool |
|------|------|
| Quick lookup | `youcom_search` |
| Comprehensive analysis | `youcom_research` |
| Specific page content | `youcom_extract` |
| Cloudflare/GitHub blocks | `youcom_search` β uses browser-fetched results when direct HTTP is blocked |
## Escalation Order
```
youcom_search (free) β youcom_research (paid, confirm first) β youcom_extract (paid, confirm first)
```
When free search is insufficient, escalate to paid research.
## Troubleshooting
### "YOUCOM_API_KEY environment variable is not set"
The API key is not loaded. Source your `.env` or restart the gateway:
```bash
source ~/.openclaw/.env
systemctl --user restart openclaw-gateway
```
### "HTTP Error 401 / 403"
Invalid or expired API key. Check or regenerate at [you.com/platform/api-keys](https://you.com/platform/api-keys).
### "HTTP Error 429"
Rate limit hit. Wait 30 seconds and retry.
### "name or service not known"
DNS failure. Check internet connection.
## Python Dependencies
No third-party dependencies. Uses Python standard library only:
- `urllib.request` β HTTP GET/POST
- `urllib.parse` β URL encoding
- `json` β JSON parsing
- `argparse` β CLI argument parsing
## API Endpoints Used
| Tool | Method | Endpoint |
|------|--------|----------|
| `youcom_search` | GET | `https://api.you.com/v1/agents/search` |
| `youcom_research` | POST | `https://api.you.com/v1/research` |
| `youcom_extract` | POST | `https://ydc-index.io/v1/contents` |
don't have the plugin yet? install it then click "run inline in claude" again.