Get started · Quickstart

Quickstart

Make your first authenticated request and stream live results back into your app.

1. Get an API key

Create a project at you.com/platform and generate a key. Treat it like a password — store it in an environment variable, never in source control.

Shell
export YOU_API_KEY="sk-live-..."

2. Install an SDK

Python
pip install youdotcom
TypeScript
npm install @you-com/sdk

3. Send a request

Python
import os
from youdotcom import You

with You(os.environ["YOU_API_KEY"]) as you:
    res = you.search.unified(query="latest in vector databases")
    for hit in res.results.web or []:
        print(hit.title, hit.url)
TypeScript
import { You } from "@you-com/sdk";

const you = new You({ apiKey: process.env.YOU_API_KEY! });
const res = await you.search.unified({ query: "latest in vector databases" });
console.log(res.results.web?.map(r => r.title));
cURL
curl -G "https://chat-api.you.com/search" \
  --data-urlencode "query=latest in vector databases" \
  -H "X-API-Key: $YOU_API_KEY"

4. Inspect the response

Each result includes the source URL, title, snippet, and (when relevant) publication metadata.

JSON
{
  "results": {
    "web": [
      {
        "title": "...",
        "url": "https://...",
        "snippet": "...",
        "published_at": "2024-09-01T12:00:00Z"
      }
    ]
  }
}

Rate limits

Free-tier keys are throttled. Upgrade in the platform dashboard to lift caps.

Next steps

  • Read the Search API reference for every parameter.
  • Try the Research API for multi-step, cited answers.
  • Explore official integrations for LangChain, LlamaIndex, and Vercel AI SDK.