# Y2

> Y2 is the context layer for real-world intelligence. It turns changing external signals and private project evidence into source-backed context that people, AI models, and agents can reuse through recurring research, multi-model Chat, Projects, ontology-backed graphs, Automations, MCP, webhooks, and APIs.

The full documentation is available at [https://y2.dev/llms-full.txt](https://y2.dev/llms-full.txt).

## When to use Y2

Use Y2 when an agent or team needs to monitor a changing real-world topic, investigate connected entities and incidents, produce a source-backed briefing, retrieve bounded context for another workflow, or deliver recurring intelligence through an API, webhook, report, or supported MCP client.
Call the REST API for explicit reads and writes, webhooks for configured asynchronous delivery, and the separately distributed MCP package for local tool discovery. Start from the OpenAPI contract, authenticate server-side with `Authorization: Bearer <Y2_API_KEY>`, grant only required scopes, and retain response request IDs for diagnostics.
Do not treat Y2 or its generated output as the original source or as an autonomous final decision maker. Review consequential findings against the cited evidence and check documented availability and plan limits before designing a dependency.

## Y2 Developer Resources

- [Y2 Developer Hub](https://y2.dev/developers): Predictable starting point for API, OpenAPI, authentication, webhooks, MCP, and agent integration guidance.
- [Y2 OpenAPI 3.1 JSON](https://y2.dev/openapi.json): Machine-readable API contract for tool generation and function calling.
- [Y2 OpenAPI 3.1 YAML](https://y2.dev/api/openapi.yaml): Canonical human-reviewable API contract.
- [Y2 API Authentication](https://y2.dev/docs/api/authentication): Bearer keys, workspace binding, scopes, rate limits, and structured errors.
- [Y2 Webhooks](https://y2.dev/docs/api/webhooks): Webhook resources and subscription delivery configuration.
- [Y2 MCP Setup](https://y2.dev/docs/api/mcp): Connect an assistant with scoped OAuth or configure the local MCP package.

## Product Overview

- [Automated Intelligence Briefings with Sources | Y2](https://y2.dev/solutions/intelligence-briefings): Turn a recurring research question into a scheduled, source-backed intelligence briefing. Configure topics, UTC schedules, email, and webhook delivery in Y2.
- [Y2 Pricing | Free, Lite, Pro, and Elite Plans](https://y2.dev/pricing): Compare Y2 plans for recurring intelligence briefings, private Projects, API access, MCP, and team delivery. Review monthly and annual billing and trial terms.
- [What is Y2?](https://y2.dev/what-is-y2): How Y2 turns changing external signals and private project evidence into source-backed context that people, AI models, and agents can reuse.
- [Situation Room](https://y2.dev/docs/osint): Open-source event, market, prediction, cyber, and country context with source-specific update frequencies.
- [Best OSINT Platforms for Real-Time Global Intelligence](https://y2.dev/blog/best-osint-platforms-real-time-global-intelligence): A sourced comparison of Y2, Maltego, Flashpoint, Recorded Future, Palantir, and MISP by monitoring, graph, threat-intelligence, and cost requirements.
- [Graph Intelligence](https://y2.dev/docs/api/intel): Entity and incident graph APIs that connect people, organizations, countries, CVEs, markets, signals, and supporting observations.
- [Custom Topic Monitoring](https://y2.dev/docs/profiles): Persistent profiles for topics, regions, suppliers, markets, risks, and organizations with scheduled intelligence reports.
- [Multi-model AI Chat](https://y2.dev/docs/chat): Change the eligible model while keeping the conversation and its Y2 tool context together, with provider-side ZDR routing by default.
- [Projects and Automations](https://y2.dev/docs/projects): Organize private evidence around one objective and run eligible scheduled follow-up without publishing Project content to Global Knowledge.

## API and Client Guides

- [API Reference](https://y2.dev/docs/api): REST API overview with base URLs, scopes, generated endpoint docs, OpenAPI, and x402 pay-per-request notes.
- [TypeScript](https://y2.dev/docs/sdks/typescript): Generate types from OpenAPI and call Y2 from a server-side TypeScript transport.
- [Python](https://y2.dev/docs/sdks/python): Build a small standard-library client around the current Y2 HTTP contract.
- [Command Line](https://y2.dev/docs/sdks/cli): Install Y2 Information Dominance, save an API key, run Agent Y2, or use curl and jq for direct API work.

## Plans and Availability

- [Y2 Desktop Downloads](https://y2.dev/download): Current Mac and Windows release availability. Installer links appear after verified publication; the web app remains available.
- [Desktop App Guide](https://y2.dev/docs/apps): System requirements, bundled installation, shared cloud workspace, updates, and troubleshooting.
- [Plans and Limits](https://y2.dev/docs/plans): Current pricing, workspace access, profile and delivery limits, Chat credits, API-key eligibility, Projects, Automations, and organization features.
- [Global Knowledge](https://y2.dev/docs/api/global-knowledge): Private-beta availability and authorization boundaries for bounded retrieval.
- [Context as a Service for Industrial AI Agents](https://y2.dev/blog/owned-context-compounds-rented-context-decays): A sourced industrial example with explicit product and availability boundaries.

## Blog Guides

- [AI Agent Memory: Context, Retrieval, and Lasting Evidence](https://y2.dev/blog/ai-agent-memory): Understand AI agent memory, how it differs from a context window and RAG, and how to retain useful evidence across recurring intelligence workflows.
- [AI Agent Security Best Practices for Intelligence Work](https://y2.dev/blog/ai-agent-security-best-practices): Apply AI agent security best practices to OSINT and intelligence workflows: scoped credentials, untrusted evidence, protected memory, and bounded actions.
- [How to Automate an Intelligence Newsletter with Y2](https://y2.dev/blog/automate-newsletter-with-y2): Create a recurring research profile, review its cited report, and deliver it by email or connect it to your newsletter platform through a webhook and API.
- [Best OSINT Aggregation Tools in 2026: Choose by Workflow](https://y2.dev/blog/best-osint-aggregation-tools-2026): Compare Y2, Maltego, Shodan, VirusTotal, Recorded Future, Babel Street, Flashpoint, and ShadowDragon by research task, evidence, integration, and buying criteria.
- [Best OSINT Platforms for Real-Time Global Intelligence (2026)](https://y2.dev/blog/best-osint-platforms-real-time-global-intelligence): Compare Y2, Maltego, Flashpoint, Recorded Future, Palantir, and MISP for global monitoring, threat dashboards, relationship graphs, and cost.
- [Cyber Threat Intelligence AI Agent: A Practical Guide](https://y2.dev/blog/cyber-threat-intelligence-ai-agent): Build a cyber threat intelligence AI agent that connects CVEs, exploitation evidence, asset exposure, and cited findings in a reviewable workflow.
- [Feedly Alternatives for Intelligence Briefings: What to Compare](https://y2.dev/blog/feedly-alternatives-for-intelligence-briefings): Compare Feedly, Y2, and Perigon for recurring intelligence briefings, cited research, delivery, and agent access. Use a practical evaluation worksheet.
- [Financial Intelligence API for Agents: What to Look For](https://y2.dev/blog/financial-intelligence-api-for-agents): Choose a financial intelligence API for agents using source provenance, units, timestamps, economic context, and scoped access. Includes a Y2 example.
- [The Game Is Rigged (And Everyone Knows It)](https://y2.dev/blog/game-is-rigged): Large organizations have intelligence teams. Everyone else has spare minutes and scattered tabs. What if that gap didn’t have to exist?
- [How Y2 Works](https://y2.dev/blog/how-y2-works): A simple engineering map of Y2's report engine, from recursive research to event provenance, ontology enrichment, signal aggregation, and fusion.
- [MCP Context: Tools, Resources, Prompts, and Agent Memory](https://y2.dev/blog/mcp-context): Learn what MCP context means, how tools, resources, and prompts reach an AI application, and why context exchange differs from persistent agent memory.
- [MCP Scoped API Key: Least-Privilege Access for Agents](https://y2.dev/blog/mcp-scoped-api-key): Configure an MCP scoped API key for Y2, choose read scopes by task, understand workspace boundaries, and distinguish local credentials from remote OAuth.
- [MCP Server for OSINT: Connect Agents to Cited Evidence](https://y2.dev/blog/mcp-server-for-osint): Use an MCP server for OSINT to query regional events and source health. Set up Y2, inspect tools, scope access, and preserve evidence in agent briefs.
- [MCP Server for Threat Intelligence: A Defender's Guide](https://y2.dev/blog/mcp-server-for-threat-intelligence): Evaluate an MCP server for threat intelligence, query Y2 CVEs and cyber graphs, and separate evidence retrieval from security response permissions.
- [The Missed Opportunity: What Are You Missing Right Now?](https://y2.dev/blog/missed-opportunity): In an age of information overload, the real risk isn’t lack of access—it’s missing what matters.
- [OSINT Search Tools: Free vs Paid Options and the Coverage Gaps Between Them](https://y2.dev/blog/osint-search-tools-free-vs-paid-coverage-gaps): Compare free and paid OSINT search tools, their monitoring, graph, and API capabilities, and the coverage gaps teams still need to solve.
- [Context as a Service for Industrial AI Agents](https://y2.dev/blog/owned-context-compounds-rented-context-decays): How reusable, source-backed context helps industrial AI agents track supplier, production, logistics, policy, and cyber changes without rebuilding every investigation.
- [Palantir Alternatives for Smaller Intelligence Teams](https://y2.dev/blog/palantir-alternative-gotham-class-platforms-smaller-security-teams): Compare alternatives to Palantir by the work you need: link analysis, specialist threat intelligence, recurring briefings, and API integrations.
- [The 'Read It Later' Paradox](https://y2.dev/blog/read-it-later): Most of what we save to read later is never read. In fast-moving industries, that delay can be costly.
- [Catharcism in New Jerusalem](https://y2.dev/blog/research/catharcism-in-new-jerusalem): End-to-End Systemic Vulnerability Assessment of the US Financial System.
- [Decentralized Financial Security is National Security](https://y2.dev/blog/research/friction-is-the-feature): In an era where economic resilience is synonymous with national security, the pursuit of cyber-economic sovereignty forms the bedrock of safeguarding citizenry.
- [The Great Capitulation](https://y2.dev/blog/research/great-capitulation): First principles on capital markets in the information age.
- [Sovereign Debt Crisis to Sovereign Digital Transformation](https://y2.dev/blog/research/sovereign-debt-crisis-to-digital-transformation): We have plenty of intelligence. The problem is making it usable.
- [The Art of War in the Information Age](https://y2.dev/blog/research/the-art-of-war-in-the-information-age): The greatest victory is that which requires no battle. ― Sun Tzu, The Art of War
- [Welcome to the Situation Room](https://y2.dev/blog/situation-room): We built a global intelligence command center. Now it's yours.
- [How to Use Y2 for Supply Chain Risk Management](https://y2.dev/blog/supply-chain-risk-management-with-y2): Create a Y2 profile for suppliers, ports, materials, and regions, then pull the intelligence into your internal tools with the Y2 API.
- [The Difference Between Gambling and Investing is Information](https://y2.dev/blog/the-difference-between-gambling-and-investing-is-information): Same markets. Different information. Different results. The real edge isn't intelligence — it's systems.
- [Y2’s Ontology: Connecting Cyber, Market, and Global Risk](https://y2.dev/blog/y2-ontology-cyber-market-global-tracking): See how Y2 connects cyber, market, and global intelligence through entities, relationships, events, and evidence to support recurring research.
- [Y2 vs Perigon for Intelligence Briefings](https://y2.dev/blog/y2-vs-perigon-intelligence-briefings): Compare Y2 and Perigon for scheduled research, source links, delivery, investigation workflows, and API access before running a briefing pilot.
- [Your AI Agent's Memory Resets Every Session. That's a Workflow Problem, Not a Data Problem](https://y2.dev/blog/your-ai-agents-memory-resets-every-session-thats-a-workflow-problem): You wire an agent up to a good data source, ask it a real question, and get a genuinely useful answer. Then two weeks later you ask something close to the same question, and the agent starts from zero.

## Overview

- [Getting Started](https://y2.dev/docs): Create your Y2 workspace and set up your first intelligence profile or subscription.

## Plans and Limits

- [Plans and Limits](https://y2.dev/docs/plans): Reference for Y2 workspace plans, feature availability, and enforced limits.

## Situation Room (OSINT)

- [Country Intelligence Cards](https://y2.dev/docs/osint/country-cards): Open and interpret the country-level dossier in the Situation Room
- [Data Infrastructure](https://y2.dev/docs/osint/data-infrastructure): How Y2 ingests, normalizes, resolves, retains, and serves intelligence data
- [Situation Room](https://y2.dev/docs/osint): Monitor geospatial events, infrastructure, network threats, tracking data, and financial signals
- [Intelligence Sources](https://y2.dev/docs/osint/sources): Identify scheduled feeds, internal observations, reference overlays, and source-health signals

## Y2 News Terminal

- [News Signal Feed](https://y2.dev/docs/news): Monitor direct-source news signals and 12-hour topic recaps
- [AI News Recaps](https://y2.dev/docs/news/recaps): Read and retrieve cached 12-hour summaries for selected News feeds
- [Topics and Feeds](https://y2.dev/docs/news/topics): Reference for the News Signal Feed topic catalog and identifiers

## Projects

- [Create Your First Project](https://y2.dev/docs/projects/getting-started): Tutorial for creating a Project, attaching intelligence, and starting a Project-scoped chat.
- [Projects](https://y2.dev/docs/projects): Understand how Projects keep chats, evidence, documents, graphs, and intelligence outputs inside one workspace-bound objective.
- [Organize Intelligence in a Project](https://y2.dev/docs/projects/organizing-intelligence): How-to guide for connecting resources, evidence, private knowledge, graphs, and chats to one Project.
- [Projects Reference](https://y2.dev/docs/projects/reference): Reference for Project availability, ownership, views, resources, limits, and lifecycle behavior.

## Automations

- [Create an Automation](https://y2.dev/docs/automations/creating): Tutorial for configuring and verifying a scheduled or report-triggered Agent Y2 Automation.
- [Automations](https://y2.dev/docs/automations): Understand Pro and Elite Automations that run Agent Y2 on a schedule or after a profile report completes.
- [Automations Reference](https://y2.dev/docs/automations/reference): Reference for Automation availability, quotas, triggers, statuses, notifications, billing, and workspace checks.

## Report Workflow

- [InfoOps Report Workflow](https://y2.dev/docs/workflows): Understand the durable research, synthesis, enrichment, and delivery pipeline behind profiles

## Information Operations

- [Branding Templates](https://y2.dev/docs/profiles/branding): Create reusable branding for reports, email, SMS, and audio delivery
- [Create a Profile](https://y2.dev/docs/profiles/creating): Create an Information Operations profile with the current three-step Y2 editor.
- [Information Operations](https://y2.dev/docs/profiles): Understand how Y2 profiles turn recurring questions into research and report workflows.
- [Schedule Profile Reports](https://y2.dev/docs/profiles/scheduling): Configure and change the UTC schedule used by an Information Operations profile.
- [Share a Profile](https://y2.dev/docs/profiles/sharing): Publish a workspace-owned profile for community discovery and understand subscriber behavior.

## Audio Reports

- [Audio Reports](https://y2.dev/docs/audio): Configure, generate, play, and retrieve narrated intelligence reports

## Delivery

- [Email Delivery](https://y2.dev/docs/delivery/email): Send each profile's intelligence reports to an account or Elite workspace audience
- [SMS Delivery](https://y2.dev/docs/delivery/sms): Send concise report summaries to a verified account phone
- [Webhook Delivery](https://y2.dev/docs/delivery/webhooks): Deliver compact CloudEvents when intelligence reports are published

## API Reference

- [Agent Y2 API](https://y2.dev/docs/api/agent-y2): Stream Y2's preconfigured workspace-aware agent through native or OpenAI-compatible requests
- [AI Quickstart](https://y2.dev/docs/api/agentic-dx): Ground an AI coding agent in Y2's generated docs, API contract, tenant model, and verification loop
- [Authentication](https://y2.dev/docs/api/authentication): Create, scope, send, rotate, and troubleshoot workspace-bound Y2 API keys
- [Automations API](https://y2.dev/docs/api/automations): Manage durable Agent Y2 Automation definitions and run history through the Y2 API.
- [Y2 Global Knowledge](https://y2.dev/docs/api/global-knowledge): Retrieve bounded, authorized evidence across Y2 reports and signal assessments
- [API Overview](https://y2.dev/docs/api): Choose the correct Y2 API surface, authentication path, version root, and generated contract
- [Integration Recipes](https://y2.dev/docs/api/integration-recipes): Build grounded agents, GIS imports, warehouse syncs, and durable intelligence pipelines
- [Query the Intel API (v2)](https://y2.dev/docs/api/intel): Find ontology incidents, entities, signals, markets, financial indicators, and cyber graphs
- [Connect Y2 through MCP](https://y2.dev/docs/api/mcp): Connect Y2 Intel to an assistant with OAuth or configure the local MCP package
- [Migrate to Canonical API Responses](https://y2.dev/docs/api/migration-v1-1): Adopt public IDs, pagination, representations, mutation preconditions, and CloudEvents
- [Build with the News API](https://y2.dev/docs/api/news): Discover feeds, page direct-source news items, and retrieve AI-generated topic recaps
- [Ontology Ledger API](https://y2.dev/docs/api/ontology-ledger): Open subjects, append evidenced records, fold at a record time and a valid time, export STIX 2.1, and verify the seal
- [Use the OpenAPI Contract](https://y2.dev/docs/api/openapi): Download, inspect, generate from, and safely update Y2's OpenAPI 3.1 specification
- [Query the OSINT API](https://y2.dev/docs/api/osint): Read normalized events, country intelligence, geospatial feeds, source health, and FININT
- [Manage Profiles through the API](https://y2.dev/docs/api/profiles): List subscriptions, create and update owned profiles, configure delivery, and retrieve reports
- [Projects API](https://y2.dev/docs/api/projects): Create, list, inspect, update, archive, and restore owner-private Projects through the Y2 API.
- [OpenAI-compatible Agent Y2 chat stream](https://y2.dev/docs/api/reference/agent-y2/createY2OpenAIChatCompletion): Routes OpenAI-style chat completions requests to Agent Y2 and streams text or client-side tool-call responses to compatible clients. v1 supports `messages`, `stream: true`, optional `model` set to `y2-agent` or `agent-y2`, optional `threadId`, optional bounded `metadata`, and bounded OpenAI function tools. Arbitrary models are unsupported. Without client tools, Agent Y2 keeps its fixed Copilot instructions and Y2 tools. A non-empty `tools` array selects harness mode: system and developer messages become the client instructions, tool-call history is preserved, and tool calls are returned to the client without server-side execution. v1 requires an API key and does not support x402. Both Agent Y2 routes share a throttle of 5 requests/minute and 100/day per key, plus 10 requests/minute and 250/day per user or workspace. A `402` indicates subscription, Agent Y2 credit, or upstream-provider credit exhaustion, not an x402 challenge.
- [Agent Y2](https://y2.dev/docs/api/reference/agent-y2): API-key streams for the preconfigured Y2 Agent and compatibility endpoint
- [Stream a Y2 Agent response](https://y2.dev/docs/api/reference/agent-y2/streamAgentY2Chat): Streams the preconfigured Y2 Agent with the same tools, entitlements, the shared workspace Agent Y2 credit pool, and API-key rate limits as the Y2 app copilot. This is not a general multi-model API. v1 callers cannot choose models, use onboarding mode, or attach files. Transcript history supplies user/assistant context but cannot override the fixed system instructions. v1 requires an API key and does not support x402. Both Agent Y2 routes share a throttle of 5 requests/minute and 100/day per key, plus 10 requests/minute and 250/day per user or workspace. A `402` indicates subscription, Agent Y2 credit, or upstream-provider credit exhaustion, not an x402 challenge.
- [Create an Automation](https://y2.dev/docs/api/reference/automations/createAutomation): Creates a draft, active, or paused Agent Y2 Automation.
- [Get an Automation definition](https://y2.dev/docs/api/reference/automations/getAutomation): Returns one Automation definition and its current lifecycle state in the API key's workspace.
- [Automations](https://y2.dev/docs/api/reference/automations): Durable Agent Y2 Automation definitions and run history
- [List Automation run history](https://y2.dev/docs/api/reference/automations/listAutomationRuns): Traverse bounded Automation run history with the returned opaque cursor.
- [List Automation definitions](https://y2.dev/docs/api/reference/automations/listAutomations): Lists owner-private Automation definitions in the API key workspace. Traverse the bounded result set with the returned opaque cursor.
- [Update or archive an Automation](https://y2.dev/docs/api/reference/automations/patchAutomation): Applies a partial definition update or a status-only lifecycle change. Archived Automations cannot be resumed or edited.
- [Request a manual Automation run](https://y2.dev/docs/api/reference/automations/runAutomation): Queues an idempotent manual run request for an active Automation. The `Idempotency-Key` header is required and identifies duplicate requests.
- [Global Knowledge](https://y2.dev/docs/api/reference/global-knowledge): Bounded, provider-neutral semantic and lexical retrieval across authorized Y2 reports and signal assessments. This surface is API-key-only and does not support x402.
- [Retrieve Y2 Global Knowledge](https://y2.dev/docs/api/reference/global-knowledge/retrieveGlobalKnowledgeV2): Runs bounded hybrid retrieval over shared Y2 knowledge and, when requested, the API key's bound workspace corpus. Access identifiers and provider filters are derived by Y2; the request cannot supply a user or workspace ID. Results are discovery evidence, include source IDs and citations, and omit provider and access-control attributes. This operation requires a workspace-bound API key with `intel:knowledge`. It does not support x402. Agent Y2 keys continue to use `agent:y2`; the agent may invoke this retrieval tool internally when the workspace is entitled to Chat.
- [Endpoint Reference](https://y2.dev/docs/api/reference): Y2 endpoints generated from the OpenAPI contract.
- [Cyber entity graph](https://y2.dev/docs/api/reference/intel/getCyberGraphV2): Returns a graph rooted at a CVE, threat actor, or malware family. Requires `rootCveId`, `rootActorId`, or `rootMalwareFamilyId`. Breadth-first search depth is capped at 2.
- [Get cyber-market fusion for a company](https://y2.dev/docs/api/reference/intel/getEntityFusionV2): Requires a workspace-bound API key with intel:explorer. Places cyber, market, supply-chain, and geopolitical events about an organization or vendor, and about the parties on its exposure path, on one timeline. Exposure paths come from catalog relations (supplies, subsidiary_of, operates) and from evidenced workspace ledger claims (supplies, subsidiary-of, operates) on subjects anchored to the entity. Workspace topics that track any path entity are listed. Adjacencies pair a cyber event with market events that followed it within adjacencyDays; they are temporal co-occurrence, not causation. Incidents and prediction markets come from a bounded recent scan; coverage notes say so. The window ends at request time. Not available with anonymous x402 payment.
- [Traverse an entity relationship graph](https://y2.dev/docs/api/reference/intel/getEntityGraphV2): Traverses the ontology graph from `entityId` with breadth-first search. Returns nodes and edges to the requested depth, capped at 200 nodes. `relationKinds` limits traversed edge kinds.
- [Get an intel entity](https://y2.dev/docs/api/reference/intel/getEntityV2): Returns an entity with inbound and outbound relations, related entities, participating incidents, subject markets, recent observations, and tenant-scoped company financial observations when requested.
- [Get an intel incident](https://y2.dev/docs/api/reference/intel/getIncidentV2): Returns an incident with supporting observations, linked markets and entities, primary place, and related incidents. The server resolves the category before checking scope: `intel:cyber` for cyber, `intel:finint` for other categories, or `intel:explorer` for any.
- [Intel](https://y2.dev/docs/api/reference/intel): Ontology-backed v2 incidents, entities, markets, financial indicators, emergent signals, and cyber graphs. Served from `https://api.y2.dev/api/v2/*`. Operations accept Bearer API keys or x402 pay-per-request. Required scopes vary by resource: `intel:finint`, `intel:cyber`, or `intel:explorer`. The in-app Cyber dashboard is available on all plans. New API-key access to FININT, Cyber, and Explorer requires Pro or Elite; existing Lite API keys are grandfathered.
- [List CVE entities](https://y2.dev/docs/api/reference/intel/listCVEsV2): Lists `kind=cve` ontology entities. `q` searches CVE identifiers. Equivalent to `GET /api/v2/entities?kind=cve&q=...`.
- [Read the public intelligence change feed](https://y2.dev/docs/api/reference/intel/listChangesV2): Returns immutable public-resource lifecycle events in global order. An authenticated API key receives globally visible intelligence changes plus changes owned by its user or workspace tenant. Anonymous x402 requests receive globally visible intelligence changes only; tenant records are never exposed across scopes. The `watermark` is an opaque exclusive checkpoint: persist the returned value and send it on the next request. Replaying a checkpoint never skips later events and may safely be retried after a consumer failure. Deleted resources are represented as tombstones. Events are append-only in schema version `1.0`; no retention expiry is currently applied.
- [List workspace company financial history](https://y2.dev/docs/api/reference/intel/listCompanyFinancialObservationsV2): Requires a workspace-bound API key with intel:finint. Returns only that workspace's recorded observations, newest recorded first. Not available with anonymous x402 payment. Metric filtering uses an index; factType is applied to each bounded page, so an empty page can still have a next cursor. History reflects retained Y2 observations, not complete filing coverage or guaranteed historical availability. SEC imports retain JSON record pointers, not page/quote spans, and do not establish original publication timestamps. Unsupported or repeated query parameters are rejected with HTTP 400.
- [List intel entities](https://y2.dev/docs/api/reference/intel/listEntitiesV2): Lists ontology entities, including people, organizations, countries, CVEs, threat actors, vessels, aircraft, facilities, vendors, software, and protocols. `q` searches `canonicalName`; `kind` filters by exact kind.
- [List FININT indicators](https://y2.dev/docs/api/reference/intel/listFinintIntelV2): Lists dimension-filtered FININT indicators from the same data as `GET /api/v1/osint/finint`, using the `intel:finint` scope and ontology-aware filters.
- [List intel incidents](https://y2.dev/docs/api/reference/intel/listIncidentsV2): Lists deduplicated, scored ontology incidents linked from the OSINT cache. Filters by category, severity, status, or last-observed lower bound. Required scopes vary by `category` filter: - `category=cyber` → `intel:cyber` or `intel:explorer` - any other category → `intel:finint` or `intel:explorer` - no `category` filter → `intel:explorer` Supports x402 pay-per-request. Requests without `Authorization` return `402 Payment Required` with payment requirements; retry with a signed `PAYMENT-SIGNATURE` header.
- [List intel markets](https://y2.dev/docs/api/reference/intel/listMarketsV2): Lists Y2-derived, Polymarket, Kalshi, and Manifold ontology markets keyed by `marketKey`. Filters by source and lifecycle status. Each market links to subject entities and may link to an underlying incident.
- [List tagged emergent signals](https://y2.dev/docs/api/reference/intel/listSignalsV2): Lists cached Y2 emergent SIGINT signals with ontology-aligned subjects, normalized subject keys, tags, source-report metadata, timestamps, and available geographic, observation, or entity links. Required scopes vary by `domain` filter: - `domain=cyber` or `domain=technology` -> `intel:cyber` or `intel:explorer` - `domain=markets` or `domain=supply_chain` -> `intel:finint` or `intel:explorer` - other domain filters -> `intel:explorer` - no `domain` filter -> any of `intel:cyber`, `intel:finint`, or `intel:explorer` Public x402 callers receive global and community signals. Authenticated API-key callers also receive authorized workspace and private rows.
- [List threat actor entities](https://y2.dev/docs/api/reference/intel/listThreatActorsV2): Lists `kind=threat_actor` ontology entities. Equivalent to `GET /api/v2/entities?kind=threat_actor&q=...`.
- [News](https://y2.dev/docs/api/reference/news): News Terminal items, feeds, and AI recaps
- [List available news feeds](https://y2.dev/docs/api/reference/news/listFeeds): Lists news feed topics and descriptions. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List news items](https://y2.dev/docs/api/reference/news/listNews): Lists cached Y2 News Terminal items with topic filters and pagination. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List AI-generated recaps](https://y2.dev/docs/api/reference/news/listRecaps): Lists AI-generated recaps for selected topics and timeframe. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Append a ledger record](https://y2.dev/docs/api/reference/ontology-ledger/appendLedgerRecordV2): Requires a workspace-bound API key with ledger:write and an owner, admin, or member role. Appends one designator, observation, or claim. A designator with the same kind, namespace, and normalized value is reused (200, created false). Every claim cites at least one observation. The first line of a claim key supersedes nothing; every later line, including a retraction, must supersede the current head, or the request fails with 409. Verification must be one the cited evidence supports: cross-linked and corroborated need retrievals of two different pages; analytic means the only support is an analyst note. Other rule failures return 400 with the rule codes in detail. Send an Idempotency-Key header to make retries safe.
- [Export a ledger subject as STIX 2.1](https://y2.dev/docs/api/reference/ontology-ledger/getLedgerSubjectStixV2): Requires a workspace-bound API key with ledger:read. Projects the subject's fold to a STIX 2.1 bundle: identity objects for subjects, cyber-observable objects for email, handle, domain, hostname, URL, and ASN designators, and relationship objects for claims with confidence, start_time, stop_time, and the cited observations as external references. Verification state and the claim key travel in a property extension. An unconfirmed same-as exports as related-to; duplicate-of and attributed-to are never emitted. history=true adds retracted heads as revoked relationships. STIX ids carry the SHA-256 digest of a per-workspace key in UUID form, so they are stable and do not reveal the workspace. An explicit validAt cursor scopes object IDs to that valid-time snapshot. A reassertion after revocation starts a new relationship ID. If the bounded subject neighborhood is incomplete, returns HTTP 400 VALIDATION_ERROR; export the paginated ledger records and project the complete log offline instead.
- [Fold a ledger subject](https://y2.dev/docs/api/reference/ontology-ledger/getLedgerSubjectV2): Requires a workspace-bound API key with ledger:read. Returns the fold of one subject: the head of every claim key that touches it. recordedAt selects what the ledger had recorded by then; validAt keeps only heads whose valid interval contains that time. A designation outside validAt moves to unlinkedDesignations instead of disappearing. Retracted heads are listed separately. A pair with both a live same-as and a live distinct-from is contested; the fold picks no winner and never merges rows. Reads are bounded; truncated is true when a budget was reached.
- [Ontology Ledger](https://y2.dev/docs/api/reference/ontology-ledger): The workspace passive entity ledger: an append-only, SHA-256-sealed log of subjects, designators, public observations, and claims with verification states and valid-time intervals. Reads fold the log at a record time and a valid time; exports produce canonical NDJSON lines and STIX 2.1 bundles. Served from `https://api.y2.dev/api/v2/ledger/*` with workspace-bound keys holding `ledger:read` or `ledger:write`. Not available with x402 payment.
- [Export sealed ledger lines](https://y2.dev/docs/api/reference/ontology-ledger/listLedgerRecordsV2): Requires a workspace-bound API key with ledger:read. Returns ledger lines in record order after afterSeq. Each item carries the exact canonical line text, so a client can write NDJSON and run the offline reference checker (`y2-ledger check`) against it. The log is append-only: continuing from meta.nextAfterSeq never skips or repeats a line.
- [List ledger subjects](https://y2.dev/docs/api/reference/ontology-ledger/listLedgerSubjectsV2): Requires a workspace-bound API key with ledger:read. Lists the workspace's ledger subjects, newest opened first, each with its display label (the live preferred-label claim, if any) and the catalog entity it is anchored to. With entityId, returns the subjects anchored to that entity in one bounded page. An anchor is an index between the workspace ledger and the shared catalog; it is neither a claim nor a merge. Unsupported or repeated query parameters are rejected with HTTP 400.
- [Open a ledger subject](https://y2.dev/docs/api/reference/ontology-ledger/openLedgerSubjectV2): Requires a workspace-bound API key with ledger:write and an owner, admin, or member role. Appends a subject line with a class and no attributes: opening a row is not a finding. Names and identifiers arrive later as designators and claims. With entityId, the subject is anchored to that catalog entity; the entity kind must align with the class (for example, a vendor anchors an organization; a CVE anchors nothing). Send an Idempotency-Key header to make retries safe; a replay returns 200.
- [Verify the ledger seal](https://y2.dev/docs/api/reference/ontology-ledger/verifyLedgerV2): Requires a workspace-bound API key with ledger:read. Recomputes the SHA-256 seal over a window of lines after afterSeq: canonical JSON, each line's hash, contiguous seq, and each prev pointing at the line before. Rules that look up earlier records are enforced at append time and by the offline checker over a full export.
- [AI-generated intelligence brief](https://y2.dev/docs/api/reference/osint/getCountryBrief): Returns a periodically generated, cached intelligence brief for a country. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Country instability index](https://y2.dev/docs/api/reference/osint/getCountryCII): Returns a country's Conflict Indicators Index (CII) score, baseline, delta, and components. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Country-specific news](https://y2.dev/docs/api/reference/osint/getCountryNews): Returns recent country news from the OSINT event pipeline. Uses the observation's indexed ISO country attribution, not countries merely mentioned or exposed to a regional event. Includes unexpired RSS, GDELT, ACLED, News Terminal, and Y2 report observations, excluding seismic and weather categories. Filters apply before pagination; satellite detections do not consume the news result window. Results retain canonical observation IDs. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Prediction markets](https://y2.dev/docs/api/reference/osint/getCountryPredictions): Returns prediction-market probabilities and trading volumes for a country. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Stock market index](https://y2.dev/docs/api/reference/osint/getCountryStockIndex): Returns a country's primary stock index, weekly change, and currency. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [OSINT](https://y2.dev/docs/api/reference/osint): Situation Room events, feeds, country data, and source health
- [Tracked military aircraft](https://y2.dev/docs/api/reference/osint/listAircraft): Lists Wingbits ADS-B military aircraft positions, classified by type such as tanker, AWACS, or fighter. > **Status:** Aircraft ingestion has been disabled since May 8, 2026, to > reserve the shared Wingbits quota for GPS interference detection. This > endpoint may return empty or stale results. `/osint/gps-jamming` is unaffected. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Conflict Indicators Index](https://y2.dev/docs/api/reference/osint/listCII): Lists Conflict Indicators Index (CII) values with 0–100 scores and recent-change deltas. Supports region and category filters. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List cyber threat indicators](https://y2.dev/docs/api/reference/osint/listCyberThreats): Lists URLhaus malware URLs, Feodo Tracker C2 servers, and RSS cyber-feed indicators with malware family, tags, and host metadata. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Financial intelligence indicators](https://y2.dev/docs/api/reference/osint/listFinintIndicators): Lists financial intelligence (FININT) indicators from FRED macroeconomic series, Yahoo Finance markets, and EIA energy data. Each includes current and previous values, percentage change, sparkline data, and active alerts. ### Aggregate and dimension rows Most indicators are US aggregates: one row per `indicatorId` (for example, `EIA:WTI`, `FRED:DGS10`). EIA also publishes per-dimension rows tagged with `dimension`, `dimensionType`, `lat`, and `lon`: - `dimensionType=facility`: reactor outages, such as `EIA:NUKE_OUTAGE:vogtle` - `dimensionType=rto`: hourly US balancing-authority demand, such as `EIA:RTO_LOAD:PJM` - `dimensionType=port`: monthly port-level crude imports, such as `EIA:CRUDE_IMPORT:houston` Filter by `dimensionType` for dimension rows only. Aggregate rows set `dimension`, `dimensionType`, `lat`, and `lon` to null. Nuclear-outage rows with `outagePct > 0` publish `economic` map events to the OSINT cache. RTO and crude-import rows do not publish map events. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [GPS interference zones](https://y2.dev/docs/api/reference/osint/listGPSJamming): Lists GPS interference zones inferred from ADS-B navigation-accuracy degradation and aggregated into H3 cells. Coverage spans 22 theaters on a tiered cadence within the shared Wingbits quota: | Tier | Cadence | Theaters | | --------- | --------- | ------------------------------------------------------------------------------------------------- | | Hot | Hourly | iran, blacksea, israelgaza, redsea, taiwan, scs | | Watch | Every 3h | emed, korea, caucasus, kaliningrad-tight, finland-russia, us-south, bashi-luzon, east-china-sea | | Perimeter | Every 6h | us-pacom-west, us-northeast, aleutian-bering, baltic-south, giuk-greenland | | Daily | Every 24h | baltic-north, us-north, arctic-greenland-pass | Records expire 30 minutes after fetch. Align polling with the theater's tier. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Military posture by theater](https://y2.dev/docs/api/reference/osint/listMilitaryPosture): Lists theater posture assessments based on Wingbits ADS-B military aircraft activity. Each includes a `normal`, `elevated`, or `critical` posture and aircraft counts by type. > **Status:** Aircraft ingestion has been disabled since May 8, 2026, to > reserve the shared Wingbits quota for GPS interference detection. This > endpoint may return empty or stale results. `/osint/gps-jamming` is unaffected. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List threat events](https://y2.dev/docs/api/reference/osint/listOsintEvents): Lists Situation Room threat events. Supports category and severity filters. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List map events with coordinates](https://y2.dev/docs/api/reference/osint/listOsintMapEvents): Lists geolocated OSINT events for map display. Excludes events without coordinates. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Search regional OSINT events](https://y2.dev/docs/api/reference/osint/listOsintRegionalEvents): Searches OSINT events across RSS, USGS, GDACS, ACLED, direct News Terminal items, other threat feeds, and Y2 report extractions. Filters by region, country code, bounding box, radius, source, category, severity, time window, or title text. Text search falls back to description substrings. All filters compose with AND, including coordinate and region filters. Events without coordinates remain unless `requireCoordinates=true` or a bounding-box or radius filter is supplied. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [List prediction markets](https://y2.dev/docs/api/reference/osint/listPredictionMarkets): Lists Polymarket and Kalshi markets by descending volume with probabilities, volume, and outcomes. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Data source health](https://y2.dev/docs/api/reference/osint/listSourceStatus): Lists OSINT source health, circuit-breaker state, and failure counts. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Naval vessel positions](https://y2.dev/docs/api/reference/osint/listVessels): Lists USNI fleet-tracker positions for carrier strike groups and warships. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Y2 report-extracted events](https://y2.dev/docs/api/reference/osint/listY2Events): Lists Y2SOURCE events extracted from intelligence reports with classification, confidence, entities, and originating-report provenance. Returns only `sourceType: "y2_report"` events. Supports category, severity, and country-code filters. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [x402 receipt lookup](https://y2.dev/docs/api/reference/payments/getX402Receipt): Returns sanitized x402 payment status by nonce. Public: anyone with the nonce can read the receipt status.
- [Payments](https://y2.dev/docs/api/reference/payments): x402 receipt lookup
- [Create an intelligence profile](https://y2.dev/docs/api/reference/profiles/createProfile): Creates an `active` intelligence profile owned by the authenticated user with the supplied configuration.
- [Delete a profile](https://y2.dev/docs/api/reference/profiles/deleteProfile): Permanently deletes a profile owned by the authenticated user and all its subscriptions. This action cannot be undone.
- [Get a subscribed profile](https://y2.dev/docs/api/reference/profiles/getProfile): Returns a profile from an active subscription in the API key's workspace. Requires current workspace membership, including the viewer role. Private profiles must still belong to the selected workspace; community and global profiles require an active workspace subscription. Missing, unsubscribed, and inaccessible profiles all return 404. Only stable public IDs are accepted.
- [Profiles](https://y2.dev/docs/api/reference/profiles): Profile subscriptions, ownership, and configuration
- [List subscribed profiles](https://y2.dev/docs/api/reference/profiles/listProfiles): Lists active subscriptions in the API key's workspace, with profile details and delivery preferences. Requires current workspace membership; viewers can read. Private profiles must still belong to that workspace. Results are ordered by subscription creation time, newest first. Each request examines at most `limit` subscription rows. The optional text filter matches name, topic, or tags without regard to case and may return a sparse or empty page. Follow `meta.page.nextCursor` while `hasMore` is true, including when `data` is empty. Cursors are bound to the filter.
- [Update a profile (partial)](https://y2.dev/docs/api/reference/profiles/patchProfile): Updates supplied mutable fields on a profile owned by the authenticated user. Omitted fields remain unchanged.
- [Update a profile (full replacement)](https://y2.dev/docs/api/reference/profiles/updateProfile): Replaces every mutable field on a profile owned by the authenticated user.
- [Create a Project](https://y2.dev/docs/api/reference/projects/createProject): Creates an active owner-private Project in the API key workspace.
- [Get a Project](https://y2.dev/docs/api/reference/projects/getProject): Returns one Project and its current lifecycle state in the API key's workspace.
- [Projects](https://y2.dev/docs/api/reference/projects): Owner-private intelligence workspaces in the API key workspace
- [List owned Projects](https://y2.dev/docs/api/reference/projects/listProjects): Lists owner-private Projects in the API key workspace. Results are bounded, ordered by recent activity, and traversable with an opaque cursor.
- [Update, archive, or restore a Project](https://y2.dev/docs/api/reference/projects/patchProject): Applies a partial Project update. Set `status` to `archived` or `active` for the reversible lifecycle transition. Archiving pauses active bound Automations.
- [Get a report](https://y2.dev/docs/api/reference/reports/getReport): Returns a compact report by default. Use bounded `include` values or `view=agent`; request `text/markdown` for the canonical Markdown representation. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Get report audio](https://y2.dev/docs/api/reference/reports/getReportAudio): Returns audio file metadata or redirects to the CDN URL. Requires the `reports:audio` scope. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Get TTS-preprocessed report text](https://y2.dev/docs/api/reference/reports/getReportAudioText): Returns the report content preprocessed for text-to-speech synthesis. Applies pronunciation normalization for acronyms, currency, and percentages; strips HTML and Markdown; and adds branding intro/outro text. Cartesia TTS generation uses this pipeline. Requires the `reports:read` scope. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Get report ontology graph](https://y2.dev/docs/api/reference/reports/getReportGraph): Returns the report's bounded ontology graph: report-local nodes, edges, incident anchors, citations, and counts. Reports created before graph extraction return `graph: null` with zero counts. Requires the `reports:read` scope. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Get report emergent signals](https://y2.dev/docs/api/reference/reports/getReportSignals): Returns structured emergent SIGINT signals inferred from a report. Reports created before signal extraction return an empty `signals` array. Requires the `reports:read` scope. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Get report as plain text](https://y2.dev/docs/api/reference/reports/getReportText): Returns the report content stripped of all HTML tags as plain text, along with word count and estimated reading time. Requires the `reports:read` scope. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Reports](https://y2.dev/docs/api/reference/reports): Report retrieval, text, audio, signals, and ontology graphs
- [List intelligence reports](https://y2.dev/docs/api/reference/reports/listReports): Lists reports for the user's subscribed profiles by generation date, newest first. Supports x402 pay-per-request. Requests with a valid Bearer token use API-key authentication. Without a Bearer API key, start the x402 flow from the `402 Payment Required` response and `PAYMENT-REQUIRED` header; retry with `PAYMENT-SIGNATURE`.
- [Subscriptions](https://y2.dev/docs/api/reference/subscriptions): Subscription delivery management
- [Update subscription delivery method](https://y2.dev/docs/api/reference/subscriptions/updateDelivery): Changes a subscription's delivery method. Setting `webhook` requires an active `webhookConfigId`. On plans with member seats, set `emailAudience` to `workspace` to email active workspace members.
- [Create a webhook configuration](https://y2.dev/docs/api/reference/webhooks/createWebhook): Creates a webhook configuration. Requires a paid workspace plan with webhook access. The URL must use HTTPS and pass SSRF validation.
- [Delete a webhook configuration](https://y2.dev/docs/api/reference/webhooks/deleteWebhook): Deletes a webhook configuration. Returns `409` if any subscription uses it.
- [Webhooks](https://y2.dev/docs/api/reference/webhooks): Webhook configuration for paid workspaces
- [List webhook configurations](https://y2.dev/docs/api/reference/webhooks/listWebhooks): Lists the authenticated user's webhook configurations. Masks secrets.
- [Test a webhook endpoint](https://y2.dev/docs/api/reference/webhooks/testWebhook): Sends a test payload to the webhook URL, including disabled destinations. Returns `422` if the endpoint responds with an error. A successful response returns the updated webhook configuration's ETag for a subsequent enabling PUT.
- [Update a webhook configuration](https://y2.dev/docs/api/reference/webhooks/updateWebhook): Replaces mutable webhook configuration fields. `name` and `url` are required. Omitted secret and headers are cleared; omitted isActive preserves the current status. Enabling requires a successful test of the same configuration within 15 minutes.
- [Retrieve Reports through the API](https://y2.dev/docs/api/reports): List published reports and choose compact JSON, Markdown, text, signals, graph, or audio
- [Configure Report Webhooks](https://y2.dev/docs/api/webhooks): Create a signed webhook, attach it to a subscription, and process CloudEvents safely
- [Explore the API with Workbench](https://y2.dev/docs/api/workbench): Run live read requests and generate secret-safe curl, TypeScript, and Python examples
- [Pay per Request with x402](https://y2.dev/docs/api/x402): Call supported read endpoints without an API key by settling USDC on Base

## Client Guides & Tools

- [Use Y2 from the Command Line](https://y2.dev/docs/sdks/cli): Install the native Y2 harness, save an API key, and call Y2 from a terminal
- [Client Libraries and Tools](https://y2.dev/docs/sdks): Choose a typed client, direct HTTP integration, or command-line workflow for the Y2 API
- [Build a Python Client](https://y2.dev/docs/sdks/python): Create a small Python client for Y2 JSON reads, writes, errors, and pagination
- [Build a TypeScript Client](https://y2.dev/docs/sdks/typescript): Generate Y2 API types and add a small server-side fetch transport

## Workspaces

- [Workspaces](https://y2.dev/docs/workspaces): Manage workspace plans, resources, teammates, and shared usage

## Community

- [Contribute to Y2](https://y2.dev/docs/community/contributing): Share useful briefings, report problems, propose documentation fixes, and build integrations safely
- [Community](https://y2.dev/docs/community): Discover, follow, and publish public InfoOps briefing profiles
- [Browse Public Briefings](https://y2.dev/docs/community/signals): Find, inspect, follow, and manage community and Agent Y2 briefing profiles

## affiliate-program-terms-2026-09-24-v5

- [Y2 Affiliate Program Terms (2026-09-24-v5)](https://y2.dev/docs/affiliate-program-terms-2026-09-24-v5): Complete terms for Pro and Elite referral commissions and fixed payout deductions

## affiliate-program

- [Join and Manage the Affiliate Program](https://y2.dev/docs/affiliate-program): Enroll from Settings, share your referral link, and monitor referral activity

## apps

- [Desktop App](https://y2.dev/docs/apps): Install Y2 for Mac or Windows, connect your existing workspace, and manage desktop updates.

## Changelog

- [March 2026 Release Archive](https://y2.dev/docs/changelog/2026-03): Historical Y2 Intelligence Platform release notes from March 2026.
- [June 2026 Release Archive](https://y2.dev/docs/changelog/2026-06): Historical Y2 Intelligence Platform release notes from June 2026.
- [July 2026 Release Archive](https://y2.dev/docs/changelog/2026-07): Historical Y2 Intelligence Platform release notes from July 2026.
- [August 2026 Release Archive](https://y2.dev/docs/changelog/2026-08): Historical Y2 Intelligence Platform release notes from August 2026.
- [September 2026 Release Notes](https://y2.dev/docs/changelog/2026-09): Private chats, conversation deletion, reliability improvements, Project PDF exports, and improvements to OSINT monitoring, country news, Elite workspace allowances, and everyday navigation in Y2.
- [Platform Changelog](https://y2.dev/docs/changelog): Current Y2 Intelligence Platform release notes and dated monthly archives.

## Chat

- [Intelligence Chat](https://y2.dev/docs/chat): Use ZDR-routed models, Y2 tools, and shared workspace Agent Y2 credits

## LLM-friendly Documentation

- [LLM-friendly Documentation](https://y2.dev/docs/llms): Reference for Y2 documentation artifacts used by coding agents, retrieval systems, and MCP clients.

## Mission

- [Mission](https://y2.dev/docs/mission): Why Y2 makes continuous, source-aware intelligence accessible to more decision-makers.

## ontology

- [Catalog and Ledger Alignment](https://y2.dev/docs/ontology/explanation/catalog-alignment): How Y2's shared entity catalog and your workspace's entity ledger fit together, and why they stay separate
- [Why a Claim Ledger](https://y2.dev/docs/ontology/explanation/claim-ledger): Why Y2 records research as append-only, evidenced claims with three clocks, and why a shared name never merges two subjects
- [Cyber-Market Fusion](https://y2.dev/docs/ontology/explanation/cyber-market-fusion): Why Y2 fuses cyber, market, supply-chain, and geopolitical events per company, what the fused view shows, and what it does not claim
- [Correct, Supersede, or Retract a Claim](https://y2.dev/docs/ontology/how-to/correct-a-claim): Change what the ledger believes by appending new lines that point at the current head, without rewriting history
- [Export STIX and Verify the Seal](https://y2.dev/docs/ontology/how-to/export-and-verify): Share ledger claims as STIX 2.1, export the sealed log, and prove offline that no line was edited
- [Read the Ledger at a Point in Time](https://y2.dev/docs/ontology/how-to/read-at-a-point-in-time): Use the record-time and valid-time cursors to ask what was believed on one date about the world on another
- [Record a Claim with Evidence](https://y2.dev/docs/ontology/how-to/record-evidence): Add identifiers, systems, and supply ties to the entity ledger, each citing a public observation with an honest verification state
- [Ontology and Cyber-Market Fusion](https://y2.dev/docs/ontology): Record evidenced claims about companies, people, and systems, and see cyber and market events on one exposure timeline
- [Fusion Response](https://y2.dev/docs/ontology/reference/fusion): Fields of the cyber-market fusion view, its sources, exposure paths, provenance, adjacencies, and read budgets
- [Ledger Record Format](https://y2.dev/docs/ontology/reference/ledger-format): Record kinds, fields, the SHA-256 seal, identifiers, and every rule a ledger line must satisfy (format version 0)
- [STIX 2.1 Export](https://y2.dev/docs/ontology/reference/stix-export): How ledger subjects, designators, claims, and observations map to STIX 2.1 objects, and the Y2 ledger property extension
- [Ledger Vocabulary](https://y2.dev/docs/ontology/reference/vocabulary): Subject classes, designator kinds, observation methods, predicates, and the verification ladder
- [Tutorial: Map a Company's Cyber-Market Exposure](https://y2.dev/docs/ontology/tutorial): Anchor a ledger subject to a company, record a sourced identifier and a supplier tie, then read the fused timeline

## Vision

- [Vision](https://y2.dev/docs/vision): The long-term direction for connected, user-controlled intelligence workflows.