---
title: "Search the registry by keyword"
method: GET
path: "/api/v1/search"
tags: ["search"]
---

# Search the registry by keyword

`GET /api/v1/search`

## Request

- Base URL: `https://api.metagraph.sh`
- URL: `https://api.metagraph.sh/api/v1/search`
- Auth: none required

Fetch compact search index.

## Query parameters

- `type` 'subnet' | 'surface' | 'provider'
- `netuid` integer
- `q` string
- `fields` string
- `limit` integer
- `cursor` integer
- `page_snapshot` string
- `sort` 'netuid' | 'slug' | 'title' | 'type'
- `order` 'asc' | 'desc'

## Response `200`

Canonical artifact wrapped in the Metagraphed API envelope.

- object
  - `data` object, required
    - `contract_version` string
    - `document_count` integer, required
    - `documents` object[], required: Heterogeneous per-type documents (subnet/surface/provider/doc), passed through verbatim as opaque JSON.
      - `artifact_path` string, required
      - `categories` string[]
      - `id` string, required
      - `netuid` integer
      - `service_kinds` string[]
      - `slug` string
      - `subtitle` string
      - `title` string, required
      - `tokens` string[], required
      - `type` 'subnet' | 'surface' | 'provider', required
      - `url` string
    - `generated_at` string, required
    - `notes` union: Public-safe notes; may be a string or a string list depending on the adapter.
      - string
      - string[]
    - `schema_version` 1, required
  - `meta` ResponseMeta, required
    - `artifact_path` string
    - `cache` 'short' | 'standard' | 'static'
    - `catalog_paging` object
      - `reason` 'catalog_changed' | 'catalog_budget_exceeded' | 'catalog_unavailable', required
    - `contract_version` string, required
    - `generated_at` string, nullable: Deterministic build content marker (epoch by default); not a wall clock. Use published_at for human-facing freshness.
    - `observed_through` string, date-time, nullable: How far the tier that answered this request has observed at all. A payload reporting no activity at or before this time is a measured absence; one whose subject is newer is outside coverage, not empty. Null when the horizon is unreadable.
    - `pagination` PaginationMeta
      - `collection` string, required
      - `cursor` integer, required
      - `limit` integer, required
      - `next_cursor` integer, nullable, required
      - `order` 'asc' | 'desc'
      - `returned` integer, required
      - `snapshot` string: Present only for page_snapshot paging. Echo as page_snapshot on subsequent pages; a changed collection or query requires a restart.
      - `sort` string, nullable
      - `total` integer, required
    - `published_at` string, date-time, nullable: Real publish time from the KV latest pointer, distinct from generated_at. Null before the first publish or when the control KV is unbound.
    - `source` string
    - `stale_contract` object: Present ONLY when the served artifact was built under an older contract than the live one (serve-time drift, #1001) — the body may predate a schema change. Mirrored on the x-metagraph-stale-contract response header for monitoring.
      - `built_under` string, required: Contract version the served artifact was built under.
      - `live` string, required: Current (live) contract version the Worker is running.
  - `ok` true, required
  - `schema_version` 1, required

## Other responses

- `304`: ETag matched and the cached response is still valid.
- `400`: Query parameters were malformed or unsupported.
- `404`: Artifact or API route was not found.
- `405`: HTTP method is not supported.
- `500`: Unexpected backend error.

---

[API](https://skmtc.dev/metagraph/apis/metagraphed-api.md) · [All operations](https://skmtc.dev/metagraph/apis/metagraphed-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metagraph/apis/metagraphed-api/revisions/e29036024bb1?raw)