satohub-ai Resolve API

openapi: 3.2.0
info:
  title: Sato Hub public Resolve API
  version: 1.1.0
  summary: Read access to the onchain agent library, its change feed, and the Agent Passport registry.
  description: 'Public reads need no key and no account; the projects and listings routes take a bearer key. A Sato API key is optional on every metered endpoint and only raises limits. What is free, what is paid (the plans are Sato Check Team and Platform & Data), every limit and the fee schedule are listed on the pricing page, and the same sheet is machine-readable at /api/pricing.json.


    Pricing: https://satohub.ai/pricing


    License: Catalog data CC-BY-4.0 — attribution: data by satohub.ai. Scores/liveness are informational signals, not safety or quality guarantees.


    Scores and liveness are informational signals computed from public evidence. They are not safety ratings, audits, or claims about returns. `verification_status` distinguishes self-reported from independently checked; self-reported is never presented as verified.


    Every shape this API returns is also published as a versioned JSON Schema (draft 2020-12) at https://satohub.ai/schemas — catalogue at https://satohub.ai/schemas/index.json. They are referenced from components.schemas below, and v1 is additive-only: a breaking change becomes v2 at a new URL. Validate with additional properties allowed.


    The same data is available to agents over MCP (Streamable HTTP, JSON-RPC) at https://satohub.ai/api/mcp — documented at https://satohub.ai/mcp. That endpoint is not described here because it is not REST.


    INTERPRETED ANSWERS. A route template sent literally (`{slug}`), an empty query or body, a parameter under another name (`?package=` for `?target=`) or another spelling of a chain (`8453`, `eth`, `bsc`) is answered with the closest honest thing instead of a bare 4xx, and always LABELLED: the body carries an `interpretation` object (`interpreted_as`, `requested`, `rule`, `note`; the same four keys are repeated at the top level when they cannot collide with the record''s own fields), and the response carries the header `X-Sato-Interpreted: ` (plus `Content-Location` when there is a canonical URL). An interpreted answer is never an exact match. Nothing that moves money is ever interpreted beyond a chain spelling: no amount, token, taker, recipient, deployer or slippage is defaulted, a missing chain is never assumed, a chain is never guessed from an address, and a generic network word (`mainnet`, `testnet`) is never read as a chain (the answer lists the candidates). Writes are never interpreted, and a receipt is never served for a template.'
  contact:
    name: Sato Hub
    url: https://satohub.ai
  x-guidance: 'Free: search and read the onchain-agent catalog (/api/export/index.json, /api/changes, /api/resolve) and use the MCP server at /api/mcp. Paid over x402 (USDC on Base, no account or key): GET /api/x402/history/{slug} for one listing''s daily Sato Score record, GET /api/x402/agent-economy for the weekly agent-economy series. Each paid read is priced per unit delivered (daily points or rows returned): the 402 states the exact amount, the unit, the quantity and the formula, which is also on /pricing. The Sato Score measures how open, active and verifiable a project is; it is not a safety or returns grade.'
  x-status:
    page: https://satohub.ai/status/sato-hub
    json: https://satohub.ai/api/status.json
    feed: https://satohub.ai/status/feed.xml
    note: Success ratios and latencies of Sato Hub's own hourly checks. Not a service-level agreement.
  license:
    name: CC-BY-4.0
    url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://satohub.ai
security: []
tags:
- name: Resolve
  description: Map a repository URL or package name to its listing. Exact match only.
paths:
  /api/resolve:
    get:
      tags:
      - Resolve
      operationId: resolveListing
      summary: Resolve a GitHub repository or npm package to its Sato Hub listing
      description: 'Pass exactly one of `repo` (a GitHub URL or owner/name) or `package` (an npm package name). Matching is exact: the listing''s GitHub owner/name, or a package that a listing''s deploy spec installs. Nothing fuzzy — a wrong hit would put the wrong score on somebody''s README. `sato_score` is null when the listing carries no score (editorial categories, or not yet assessed). The score is a 0-100 measure of how open, active and verifiable the project is; it is not a safety, quality or returns grade.'
      parameters:
      - name: repo
        in: query
        required: false
        schema:
          type: string
        description: GitHub repository URL (https://github.com/owner/name, .git and paths tolerated) or bare owner/name.
      - name: package
        in: query
        required: false
        schema:
          type: string
        description: npm package name, scoped allowed; a trailing @version is ignored.
      responses:
        '200':
          description: The matching listing.
          content:
            application/json:
              schema:
                type: object
                required:
                - slug
                - name
                - sato_score
                - verify_url
                - sato_url
                - matched_by
                properties:
                  slug:
                    type: string
                  name:
                    type: string
                  sato_score:
                    type:
                    - integer
                    - 'null'
                    minimum: 0
                    maximum: 100
                  sato_tier:
                    type:
                    - string
                    - 'null'
                    description: High | Medium | Low, or null when unscored.
                  verify_url:
                    type:
                    - string
                    - 'null'
                    format: uri
                    description: The public Sato Score report.
                  sato_url:
                    type: string
                    format: uri
                    description: Canonical listing page — cite this.
                  badge_url:
                    type: string
                    format: uri
                  badge_json_url:
                    type: string
                    format: uri
                  matched_by:
                    type: string
                    enum:
                    - repo
                    - package
                  matched_value:
                    type: string
                  caveat:
                    type: string
                  meta:
                    type: object
                    description: rules / coverage / next_update — see /api/export/adoption.json.
        '400':
          description: Neither parameter given, or the value is not a GitHub URL / npm name.
        '404':
          description: No listing matches. The body includes `submit_url` for adding one.
        '410':
          description: A listing matched but was RETIRED (status Deprecated — no public activity over 90 days). Body carries slug, name, status and sato_url; sato_score is null because a retired project's last score is not a current fact.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Two different credentials ride this header, and they are told apart by their shape.


        • A SATO API KEY, `sk_sato_…` — optional on every metered endpoint. It is NEVER required: each of those endpoints answers an anonymous caller at the free limits, and a key only raises the caps and attributes the calls to an account. A key may also be sent as `X-Sato-Key`. An unknown or revoked key is served as if no key were present, never refused. Limits and plans: /pricing.


        • A PRIVY ACCESS TOKEN for a signed-in account — required by the claim endpoints and the key-management endpoints. A token that is not a Sato key is treated as one of these.'
    satoKey:
      type: apiKey
      in: header
      name: X-Sato-Key
      description: 'The same optional Sato API key, on its own header. Equivalent to `Authorization: Bearer sk_sato_…`.'
externalDocs:
  description: The published Sato Hub formats, as JSON Schema.
  url: https://satohub.ai/schemas