---
title: "API Overview"
description: "Choose a Y2 API guide, authentication method, or endpoint reference"
canonical: https://y2.dev/docs/api/
---

# API Overview

Choose a Y2 API guide, authentication method, or endpoint reference

Use the Y2 API to read intelligence data, manage workspace resources, and run Agent Y2.

## Start here

[Create an API key](https://y2.dev/docs/api/create-key): Set workspace access and scopes.

[Make a request](https://y2.dev/docs/api/workbench): Run a read request in API Workbench.

[Build an integration](https://y2.dev/docs/sdks): Choose TypeScript, Python, or command-line tools.

[Endpoint reference](https://y2.dev/docs/api/reference): Check exact paths, parameters, schemas, and response headers.

## Base URLs

| API             | Base URL                    | Resources                                                                                   |
| --------------- | --------------------------- | ------------------------------------------------------------------------------------------- |
| Core v1         | `https://api.y2.dev/api/v1` | Reports, profiles, Projects, Automations, news, OSINT, webhooks, Agent Y2, and receipts     |
| Intelligence v2 | `https://api.y2.dev/api/v2` | Incidents, entities, graphs, markets, signals, change feed, knowledge retrieval, and ledger |

OpenAPI v1 paths are relative to the v1 base URL. Its v2 paths include `/api/v2` and use `https://api.y2.dev`. See [OpenAPI server selection](https://y2.dev/docs/api/openapi#compose-the-correct-request-url) before you generate a client.

## Choose authentication

| Method                                                   | Use                                                           |
| -------------------------------------------------------- | ------------------------------------------------------------- |
| [Bearer API key](https://y2.dev/docs/api/authentication) | Access resources with the key's workspace, scopes, and limits |
| [x402](https://y2.dev/docs/api/x402)                     | Pay for a supported read operation without an API key         |
| Public receipt lookup                                    | Check an x402 receipt with its nonce                          |

New keys require Pro or Elite. See [authentication requirements](https://y2.dev/docs/api/authentication#plan-requirements) for existing Lite keys and limits. Each operation declares its authentication methods in the endpoint reference.

## Task guides

| Task                                         | Guide                                                        |
| -------------------------------------------- | ------------------------------------------------------------ |
| Stream an agent response                     | [Agent Y2](https://y2.dev/docs/api/agent-y2)                 |
| Read report text, signals, graphs, or audio  | [Reports](https://y2.dev/docs/api/reports)                   |
| Create or update research profiles           | [Profiles](https://y2.dev/docs/api/profiles)                 |
| Manage private Projects                      | [Projects](https://y2.dev/docs/api/projects)                 |
| Schedule or run agent instructions           | [Automations](https://y2.dev/docs/api/automations)           |
| Read news and topic recaps                   | [News](https://y2.dev/docs/api/news)                         |
| Read events, country data, and source status | [OSINT](https://y2.dev/docs/api/osint)                       |
| Query incidents, entities, and relationships | [Intel v2](https://y2.dev/docs/api/intel)                    |
| Search reports and signal assessments        | [Global Knowledge](https://y2.dev/docs/api/global-knowledge) |
| Record observations and claims               | [Ontology Ledger](https://y2.dev/docs/api/ontology-ledger)   |
| Receive report events                        | [Webhooks](https://y2.dev/docs/api/webhooks)                 |
| Connect an assistant                         | [MCP](https://y2.dev/docs/api/mcp)                           |

## Integration reference

- [Response formats, errors, and headers](https://y2.dev/docs/api/responses)
- [OpenAPI contract](https://y2.dev/docs/api/openapi)
- [Integration recipes](https://y2.dev/docs/api/integration-recipes)
- [AI Quickstart](https://y2.dev/docs/api/agentic-dx)
- [Response migration](https://y2.dev/docs/api/migration-v1-1)