---
title: "API discovery"
method: GET
path: "/api/v1"
tags: ["System"]
---

# API discovery

`GET /api/v1`

Unauthenticated API-origin discovery document pointing agents to the canonical API base URL, full docs, web-origin OpenAPI spec, health check, and representative authenticated data routes.

## Response `200`

API discovery document

- object
  - `object` 'api_discovery', required
  - `data` ApiDiscovery, required
    - `api_base_url` string, uri, required — Canonical API origin for public V1 requests.
    - `docs_url` string, uri, required — Full agent-readable API reference.
    - `openapi_url` string, uri, required — Canonical web-origin OpenAPI JSON document.
    - `health_url` string, uri, required — Unauthenticated API health endpoint.
    - `authentication` 'Bearer API key required for data endpoints; discovery (/api/v1), health, and /api/v1/platforms are public.', required
    - `authenticated_routes` string[], required — Representative authenticated data routes. Full route coverage lives in OpenAPI and llms-full.txt.
  - `meta` ResponseMeta, required
    - `request_id` string, required — Unique request ID (req_ prefix).
    - `cached` boolean, required
    - `cache_age_s` integer, nullable — Cache age in seconds, null if not cached.

## Other responses

- `408` — Request exceeded the server's 30-second transport timeout. The timeout response has an empty body because it is generated before handler-level JSON error shaping.
- `429` — Rate limit exceeded (100 req/min; batch endpoints also reserve 100 batch item units/min before execution)

## Changes

- **2026-06-15** `5b6d6ff7692c` — 1 breaking
  - the `authentication` response property const value changed from `Bearer API key required for data endpoints; discovery and health are public.` to `Bearer API key required for data endpoints; discovery (/api/v1), health, and /api/v1/platforms are public.` for the status `200`
- **2026-06-01** `422bd4dc1611` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/0xinsider/apis/0xinsider-api/changes/api/v1/get.md)

---

[API](https://skmtc.dev/0xinsider/apis/0xinsider-api.md) · [All operations](https://skmtc.dev/0xinsider/apis/0xinsider-api/llms.txt) · [OpenAPI document](https://skmtc.dev/0xinsider/apis/0xinsider-api/revisions/137fa0fd3297?raw)