You

https://you.com/docs
Admin
You provides core infrastructure and APIs for real-time Search, Content, News, and Images, enabling...
Tokens:174,697
Snippets:1,519
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Getting Started

Source: https://you.com/docs/integrations/temporal

Steps to install the youdotcom-temporal package, set the API key, and start a local Temporal server.

```APIDOC
## Install the Package

```bash
pip install youdotcom-temporal
```

## Set Your API Key

```bash
export YDC_API_KEY="<YDC_API_KEY>"
```

Get your API key at you.com/platform.

## Start a Local Temporal Server

```bash
temporal server start-dev
```
```

--------------------------------

### Install via CLI

Source: https://you.com/docs/agents/agent-harnesses/claude-code

Install from the terminal, e.g., in a setup script. Adds the marketplace and installs the plugin with user scope.

```bash
claude plugin marketplace add youdotcom-oss/agent-skills
claude plugin install you@you-com --scope user
```

--------------------------------

### Quick demo: find Next.js 15 migration guide

Source: https://you.com/docs/agents/agent-harnesses/cursor

Example prompt to retrieve the official Next.js 15 migration guide and extract the breaking-changes section.

```text
Find the official Next.js 15 migration guide and pull the breaking-changes section verbatim.
```

--------------------------------

### Try You.com Plugin

Source: https://you.com/docs/agents/agent-harnesses/claude-code

Example prompt to try after installation. The first tool call triggers OAuth 2.1 sign-in via browser.

```text
Use you-web to find what's new in the latest TypeScript release, with sources.
```

--------------------------------

### Set You.com and OpenAI API keys

Source: https://you.com/docs/integrations/langgraph

Sets the API keys needed for the examples. Get your You.com API key at you.com/platform.

```bash
export YDC_API_KEY="<YDC_API_KEY>"
export OPENAI_API_KEY=your_openai_key

```

--------------------------------

### Set up browser tool with YouComBackend

Source: https://you.com/docs/integrations/gpt-oss

Set up the browser tool with YouComBackend to connect GPT OSS's browser tool to You.com's Web Search API. The model uses three methods: search, open, and find. This example shows the full setup and inference loop, including handling browser tool calls.

```python
import datetime
from gpt_oss.tools.simple_browser import SimpleBrowserTool
from gpt_oss.tools.simple_browser.backend import YouComBackend
from openai_harmony import (
    SystemContent,
    Message,
    Conversation,
    Role,
    load_harmony_encoding,
    HarmonyEncodingName,
)
encoding = load_harmony_encoding(HarmonyEncodingName.HARMONY_GPT_OSS)
backend = YouComBackend(source="web")
browser_tool = SimpleBrowserTool(backend=backend)
system_content = (
    SystemContent.new()
    .with_conversation_start_date(datetime.datetime.now().strftime("%Y-%m-%d"))
    .with_tools(browser_tool.tool_config)
)
system_message = Message.from_role_and_content(Role.SYSTEM, system_content)
user_message = Message.from_role_and_content(
    Role.USER, "What's the latest news on AI regulation?"
)
conversation = Conversation.from_messages([system_message, user_message])
token_ids = encoding.render_conversation_for_completion(conversation, Role.ASSISTANT)
# Run inference with your chosen backend (triton, vLLM, etc.)
output_tokens = your_inference_engine(token_ids)
# Parse the model's response
messages = encoding.parse_messages_from_completion_tokens(output_tokens, Role.ASSISTANT)
last_message = messages[-1]
# If the model invokes the browser tool, process the call and re-run inference
if last_message.recipient.startswith("browser"):
    response_messages = await browser_tool.process(last_message)
    messages.extend(response_messages)
```

--------------------------------

### Add the Marketplace and Install the You.com Plugin

Source: https://you.com/docs/agents/agent-harnesses/codex-cli

Run these two commands to add the You.com plugin marketplace and install the 'you' plugin. After installation, Codex prompts you to authenticate, and you must start a new session to load the plugin.

```bash
codex plugin marketplace add youdotcom-oss/agent-skills
codex plugin add you@you-com
```

--------------------------------

### Install You.com skills in OpenCode

Source: https://you.com/docs/build-with-agents/skills

Install the You.com skills plugin in OpenCode.

```bash
opencode plugin @youdotcom-oss/opencode
```

--------------------------------

### Install You.com skills in GitHub Copilot CLI

Source: https://you.com/docs/build-with-agents/skills

Install the You.com skills plugin in GitHub Copilot CLI. Run the marketplace add command first, then install the plugin.

```bash
copilot plugin marketplace add youdotcom-oss/agent-skills
copilot plugin install you@you-com
```

--------------------------------

### Answer API quickstart in Python

Source: https://you.com/docs/guides/answer/quickstart

Use the Answer API to get a synthesized answer with citations. Requires the youdotcom package and an API key set as YDC_API_KEY. Prints the answer and the number of citations, then lists each citation source.

```python
from youdotcom import You
with You() as you:
    response = you.answer(query="Top 5 EV-selling companies worldwide in 2025 so far")
    print(response.answer)
    print(f"\n--- {len(response.citations or [])} citations ---")
    for i, citation in enumerate(response.citations or [], 1):
        print(f"[{i}] {citation.source}")
```

--------------------------------

### Clone and run ydc-research-sample

Source: https://you.com/docs/examples/research

Clone the sample repository and run either the Python script or the web app. For Python, install the youdotcom package, set the YDC_API_KEY environment variable, and execute research.py with your question. For the web app, copy the environment file, install dependencies, and start the development server on localhost:3000.

```bash
git clone https://github.com/youdotcom-oss/ydc-research-sample.git
cd ydc-research-sample
# Python
pip install youdotcom
export YDC_API_KEY="your-key"
python research.py "your question here"
# Web app
cp .env.example .env.local   # add your API key
npm install
npm run dev                  # open localhost:3000
```

--------------------------------

### Install the SDK with pip

Source: https://you.com/docs/sdks/python-sdk

Install the youdotcom package from PyPI using pip.

```bash
pip install youdotcom
```

--------------------------------

### Install all skills with npx skills add

Source: https://you.com/docs/agents/skills

Installs the shared Agent Skills using the universal installer. This command installs all skills at once.

```bash
npx skills add youdotcom-oss/agent-skills

```

--------------------------------

### Install llama-index-retrievers-you

Source: https://you.com/docs/integrations/llamaindex

Install the package using pip.

```bash
pip install llama-index-retrievers-you
```

--------------------------------

### Install x402 packages

Source: https://you.com/docs/administration/machine-payments/x402

Install the required x402 packages for TypeScript: @x402/fetch and @x402/evm.

```bash
npm install @x402/fetch @x402/evm
```

--------------------------------

### Install the youdotcom-temporal package

Source: https://you.com/docs/integrations/temporal

Install the `youdotcom-temporal` package using pip.

```bash
pip install youdotcom-temporal
```

--------------------------------

### Start a New Codex Session

Source: https://you.com/docs/agents/agent-harnesses/codex-cli

Run 'codex' to start a new session so Codex loads the plugin after installation.

```bash
codex
```

--------------------------------

### Start the harness with npx @deepseek-ai/dsh web

Source: https://you.com/docs/agents/agent-harnesses/deepseek-harness

Starts the DeepSeek harness without a global install. Requires Node.js. Use this when dsh is not found on PATH.

```bash
npx @deepseek-ai/dsh web
```

--------------------------------

### Start simple: Use only query and count

Source: https://you.com/docs/guides/search/evaluate-us

Recommended approach: start with a simple search call using only the query and count parameters, as shown in the 'Do' example.

```python
response = you.search(query=query, count=10)  # Start simple
```

--------------------------------

### Try the you-search tool

Source: https://you.com/docs/agents/agent-harnesses/opencode

Example prompt to try after configuring the MCP server without the plugin. Uses the you-search tool from the free profile.

```text
Search for the latest releases of Bun and summarize the performance improvements.
```

--------------------------------

### Start a local Temporal server

Source: https://you.com/docs/integrations/temporal

Start a local Temporal development server using the Temporal CLI.

```bash
temporal server start-dev
```

--------------------------------

### Try the you-web skill

Source: https://you.com/docs/agents/agent-harnesses/opencode

Example prompt to try after installing the plugin. The you-web skill triggers the keyless web search tool.

```text
Use you-web to find the latest Bun release and summarize the performance improvements.
```

--------------------------------

### Start dsh and try a web search

Source: https://you.com/docs/agents/agent-harnesses/deepseek-harness

Start the DeepSeek Harness with the 'dsh web' command, then enter a prompt to test the web_search tool. The model loads bundled skills and answers through You.com with typed, citable sources.

```bash
dsh web
```

```text
Search the web for the latest DeepSeek model releases and summarize what changed.
```

--------------------------------

### SSE stream response example

Source: https://you.com/docs/api-reference/research/v1-research-task-stream

Example SSE stream response. It starts with a `connected` event, includes periodic ping comments to keep the connection alive, and ends with a terminal event (here `completed`). The stream closes when the task reaches a terminal status.

```text
"id: 0\nevent: connected\ndata: {\"type\": \"connected\", \"task_id\": \"f1e2d3c4-0000-0000-0000-000000000000\", \"status\": \"running\"}\n\n: ping - 2026-06-26T00:00:15Z\n\n: ping - 2026-06-26T00:00:30Z\n\nevent: completed\ndata: {\"type\": \"completed\", \"data\": {\"message\": \"Task completed\", \"error\": null}, \"sequence\": 0, \"task_id\": \"f1e2d3c4-0000-0000-0000-000000000000\"}\n"
```

--------------------------------

### Install @youdotcom-oss/ai-sdk-plugin and ai

Source: https://you.com/docs/integrations/vercel-ai-sdk

Install the @youdotcom-oss/ai-sdk-plugin package and the AI SDK core package using your preferred package manager (NPM, Bun, or Yarn).

```bash
# NPM
npm install @youdotcom-oss/ai-sdk-plugin ai
# Bun
bun add @youdotcom-oss/ai-sdk-plugin ai
# Yarn
yarn add @youdotcom-oss/ai-sdk-plugin ai
```

--------------------------------

### Finance Research API Python example

Source: https://you.com/docs/guides/finance-research/quickstart

Use the Finance Research API to get a cited answer from a finance-optimized index. Requires the youdotcom package and an API key stored in the YDC_API_KEY environment variable. The example sets research_effort to FinanceResearchEffort.DEEP and prints the answer content along with numbered sources.

```python
from youdotcom import You
from youdotcom.models import FinanceResearchEffort
with You() as you:
    res = you.finance_research(
        input="What were the key drivers of NVIDIA's revenue growth in fiscal year 2025?",
        research_effort=FinanceResearchEffort.DEEP,
    )
    print(res.output.content)
    for i, source in enumerate(res.output.sources, 1):
        print(f"[{i}] {source.title or 'Untitled'}: {source.url}")
```

--------------------------------

### Install the You.com OpenCode plugin

Source: https://you.com/docs/agents/agent-harnesses/opencode

Install the @youdotcom-oss/opencode plugin either via the CLI command or by adding it to the plugin array in opencode.json. The plugin registers five You.com skills and configures the You.com MCP servers.

```bash
opencode plugin @youdotcom-oss/opencode
```

```json
{ "plugin": ["@youdotcom-oss/opencode"] }
```

--------------------------------

### Research API Quickstart in Python

Source: https://you.com/docs/guides/research/quickstart

Python example using the youdotcom SDK to call the Research API with a research_effort of STANDARD. It prints the Markdown answer and enumerates the sources with their titles and URLs.

```python
from youdotcom import You
from youdotcom.models import ResearchEffort
you = You()
res = you.research(
    input="Top 5 EV-selling companies worldwide in 2025 so far",
    research_effort=ResearchEffort.STANDARD,
)
print(res.output.content)
for i, source in enumerate(res.output.sources, 1):
    print(f"[{i}] {source.title or 'Untitled'}: {source.url}")

```

--------------------------------

### Install You.com plugin from GitHub repository

Source: https://you.com/docs/agents/agent-harnesses/cursor

Enter this repository URL in Cursor's Customize panel to install the plugin from source.

```text
https://github.com/youdotcom-oss/agent-skills
```

--------------------------------

### Local stdio install of You.com MCP server in Zed

Source: https://you.com/docs/agents/agent-harnesses/zed

Sets up the You.com MCP server locally via stdio using `npx` and the `@youdotcom-oss/mcp` package. In Zed, `command` must be an object with `path`, `args`, and `env` fields, not a string. Omit `YDC_API_KEY` for free-tier behavior.

```json
{
  "context_servers": {
    "you-com": {
      "source": "custom",
      "command": {
        "path": "npx",
        "args": ["-y", "@youdotcom-oss/mcp"],
        "env": {
          "YDC_API_KEY": "<YDC_API_KEY>"
        }
      }
    }
  }
}
```

--------------------------------

### GET /v1/research/:task_id/stream

Source: https://you.com/docs/api-reference/research/v1-research-task-stream

Streams real-time progress for a background research task using Server-Sent Events (SSE). The stream starts with a connected event, includes periodic pings, and ends with a terminal event when the task completes, fails, or is cancelled.

```APIDOC
## [GET] /v1/research/:task_id/stream

### Description
Stream real-time progress for a background research task using Server-Sent Events (SSE). The stream starts with a `connected` event, followed by periodic ping comments to keep the connection alive, and closes when the task reaches a terminal status (`completed`, `failed`, or `cancelled`), at which point a terminal event matching the status name is sent. To replay events after reconnecting, pass `?from_id=N` with the last event ID you received. After the stream closes, call `GET /v1/research/{task_id}` to retrieve the full `result` object.

### Method
GET

### Endpoint
https://api.you.com/v1/research/:task_id/stream

### Parameters
#### Path Parameters
- **task_id** (string, uuid) - Required - The unique identifier of the background research task.

#### Query Parameters
- **from_id** (integer) - Optional - Defaults to `0`. Optional event ID to replay events from after reconnecting.

### Authentication
X-API-Key (string) - A unique API Key is required to authorize API access. Get your API Key with free credits.

### Request Example
```
curl https://api.you.com/v1/research/f1e2d3c4-0000-0000-0000-000000000000/stream \
     -H "X-API-Key: <apiKey>"
```

### Response
#### Success Response (200)
A Server-Sent Events stream of task progress updates.

#### Response Example
```
id: 0\nevent: connected\ndata: {"type": "connected", "task_id": "f1e2d3c4-0000-0000-0000-000000000000", "status": "running"}\n\n: ping - 2026-06-26T00:00:15Z\n\n: ping - 2026-06-26T00:00:30Z\n\nevent: completed\ndata: {"type": "completed", "data": {"message": "Task completed", "error": null}, "sequence": 0, "task_id": "f1e2d3c4-0000-0000-0000-000000000000"}\n
```

### Errors
- **401** - Unauthorized Error
- **403** - Forbidden Error
- **404** - Not Found Error
- **500** - Internal Server Error
```

--------------------------------

### Install Python SDKs with pip

Source: https://you.com/docs/integrations/daytona

Install the Daytona and You.com Python SDKs. Set DAYTONA_API_KEY in the environment where the control script runs.

```bash
pip install daytona youdotcom
```
Tokens:
Raw