> For clean Markdown of any page, append `.md` to the page URL.
> Documentation index: https://you.com/docs/llms.txt (section indexes: append `/llms.txt` to any section URL).
> Search these docs: Docs MCP at https://you.com/docs/_mcp/server (`searchDocs`, no API key).
> Call live You.com APIs: Product MCP at https://api.you.com/mcp (keyless `?profile=free` exposes `you-search` and `you-discover`. Research and finance use `/mcp/research`, `/mcp/finance`, or `?tools=` on `/mcp`). To pick an API or integration path, call `you-discover` on that server instead of guessing.
> OpenAPI: https://you.com/docs/openapi.json—auth header `X-API-Key`, env `YDC_API_KEY`.

# Sim

[Sim](https://www.sim.ai) is an open-source AI workspace where teams build and deploy AI agents on a visual canvas. The You.com integration is a single block covering all five You.com APIs—Web Search, Contents, Answer, Research, and Finance Research—plus image search and account balance, so an agent can find pages, read them, and write cited briefs without leaving the workflow.

This page covers setup and the parts that touch your You.com account. Sim documents every tool, parameter, and output field at [docs.sim.ai/integrations/youcom](https://docs.sim.ai/integrations/youcom).

## Getting Started

### Create a Workspace

Create a free account at [sim.ai](https://www.sim.ai/signup). Sim is Apache 2.0, so you can also self-host with Docker Compose or Kubernetes.

### Add the You.com Block

Drag a **You.com** block onto the workflow builder and paste in an API key from [you.com/platform](https://you.com/platform).

### Pick a Tool and Run

Select a tool, wire up its inputs, and click **Run**. Inputs can reference outputs from earlier blocks, such as text generated by an agent or rows from a table.

## Tools

All the available tools map directly to our APIs. See the [API reference](/api-reference) to learn about them.

| Tool                    | What it does                                                                                                                                                     |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Search**              | Web and news results as snippets, query-relevant highlights, or full page content. Supports freshness, country, language, domain filters, and `knowledge: core`. |
| **Get Contents**        | Clean Markdown, HTML, and page metadata for a list of URLs.                                                                                                      |
| **Answer**              | A synthesized answer with numbered citations and the web results behind it.                                                                                      |
| **Research**            | Multi-step research with effort levels from `lite` to `frontier`, structured output via JSON Schema, domain filtering, and background mode.                      |
| **Get Research Task**   | Poll a background research task and collect its cited answer and sources.                                                                                        |
| **Finance Research**    | Cited research across earnings reports, SEC filings, analyst coverage, and market news.                                                                          |
| **Search Images**       | Image URLs for a query. Beta, limited to early-access API keys.                                                                                                  |
| **Get Account Balance** | Remaining You.com API credits for the account or organization that owns the key.                                                                                 |

## What Works Well in Sim

* **Background research.** Long Research runs don't have to block the workflow. Start one in background mode, keep the workflow moving, and poll Get Research Task for the result.
* **Agent-driven calls.** The You.com block runs inside Sim's Agent block, so an agent decides when to search, read, or research instead of following a fixed path.
* **Self-hosted agents.** Sim is Apache 2.0 and self-hostable, so on-prem workflows can still call the hosted You.com APIs.

## Resources

#### [You.com on Sim](https://www.sim.ai/integrations/you-com)

Sim's integration page with setup steps and agent templates.

#### [Sim's You.com Docs](https://docs.sim.ai/integrations/youcom)

Full parameter and output tables for all eight tools.

#### [Sim on GitHub](https://github.com/simstudioai/sim)

Source code and self-hosting guides.

#### [Research API Reference](/docs/api-reference/research/v1-research)

Full Research API parameters and response schema.