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
Set workspace access and scopes.
Make a request
Run a read request in API Workbench.
Build an integration
Choose TypeScript, Python, or command-line tools.
Endpoint 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 before you generate a client.
Choose authentication
| Method | Use |
|---|---|
| Bearer API key | Access resources with the key's workspace, scopes, and limits |
| 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 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 |
| Read report text, signals, graphs, or audio | Reports |
| Create or update research profiles | Profiles |
| Manage private Projects | Projects |
| Schedule or run agent instructions | Automations |
| Read news and topic recaps | News |
| Read events, country data, and source status | OSINT |
| Query incidents, entities, and relationships | Intel v2 |
| Search reports and signal assessments | Global Knowledge |
| Record observations and claims | Ontology Ledger |
| Receive report events | Webhooks |
| Connect an assistant | MCP |