IRIS docs portal
IRIS exposes a neutral read contract over the INAPI trademark corpus: a versioned REST
API (under /v1) and a Model Context Protocol (MCP) server, both backed by the same query layer
and the same Zod schemas, so the two transports return identical results. This portal is the
human-facing onboarding documentation; it is neutral and reusable across consumers.
The authoritative schema lives in the live OpenAPI reference at
/docs(an interactive Scalar page generated from the code). These guides explain how to onboard and link to that reference — they do not duplicate the schema. When a field or endpoint detail is not spelled out here,/docsis the source of truth.
Integration guides (DOCS-01)
| Guide | What it covers |
|---|---|
| Getting started | Base URL + /v1, getting an operator-issued key, first GET /v1/brands call (curl + TS fetch), keyset pagination/filtering, the error envelope, quota basics. |
| Authentication and scopes | The X-API-Key header, scopes brands:read / insights:read (empty = unrestricted), key lifecycle (rotate/revoke/expiry), and 401 / 403 / 429 semantics. |
| Connect your AI agent (MCP) | The https://mcp.obviouy.com endpoint, X-API-Key, Streamable HTTP transport, the search_brands / get_brand_detail tools, and example client configs. |
| Code samples | Copy-paste REST (curl + TS fetch) and MCP (@modelcontextprotocol/sdk) clients. |
Contract and operations (DOCS-02)
| Document | What it covers |
|---|---|
| Changelog | Release history (Keep a Changelog style). |
| Status | Service status and where live freshness/health surfaces. |
| Versioning & deprecation | The /v1 prefix contract and how breaking changes get a new version. |
| SLA | Uptime stance, sync/freshness cadence, support expectations. |
The DOCS-02 documents are produced by the sibling plan in this phase; their links are listed here so this index is the single entry point to the whole portal.
Authoritative API reference
The full, always-current per-field REST schema is the interactive OpenAPI (Scalar) reference
served at https://iris.obviouy.com/docs. Start with the
guides above to onboard, then use that reference as the canonical schema for every endpoint,
parameter, and response shape.