Build with Yep

Choose an integration

Use the Search API when your application needs ranked web results over HTTP. Use the Agent API when Yep should turn a prompt into a sourced report with your model provider key. Use MCP when an AI client should choose and call Yep tools through OAuth.

Send your first request

Create an API key in the product and move the creation-response secret directly into the YEP_API_KEY environment variable. Then choose one runnable example:

curl --get 'https://yep.com/api/v1/search' \
  --header "Authorization: Bearer $YEP_API_KEY" \
  --data-urlencode 'query=carbon border tax 2026' \
  --data-urlencode 'limit=5'

The response is a JSON object with ranked results under results. GET and POST /api/v1/search return the same envelope; GET always projects url, title, description, and language, while POST accepts select for other fields. request_id matches the X-Request-ID response header for support and diagnostics.

{
  "request_id": "0b9f2c3e-6f1d-4c1a-9a43-2d6f1e0c8b7a",
  "duration_ms": 412,
  "select": ["url", "title", "description", "language"],
  "results": [
    {
      "rank": 1,
      "fields": {
        "url": "https://example.com/carbon-border-tax",
        "title": "Carbon border adjustment mechanisms",
        "description": "A guide to carbon border taxes and their implementation.",
        "language": "en"
      }
    }
  ]
}

Continue

Read Authentication before deploying an HTTP integration, choose the Search API or Agent API, or connect an MCP client without creating an API key.