Skip to main content

API Overview

Base URL

All endpoints are available on three chains via URL prefixes:

Authentication

HYRE uses x402 payment instead of API keys. Every paid request must include an X-PAYMENT header with a signed payment payload.
  1. Call the endpoint without payment to receive a 402 challenge.
  2. Sign the payment with your wallet.
  3. Retry with the X-PAYMENT header attached.
See x402 Protocol for details.

Standard Response Format

Every paid endpoint returns the HyreResponse envelope:
object
required
Structured data from upstream sources. Shape varies per endpoint.
string
AI-generated actionable insight in 1-2 sentences. null if all LLM models failed (HTTP 206).
string
required
Decision signal for the caller. Vocabulary depends on the endpoint segment.
number
required
LLM confidence in the signal, from 0.0 to 1.0.
string[]
required
List of upstream data sources used (e.g., ["defillama"], ["solana-rpc", "jupiter"]).
string
Name of the LLM model that produced the insight. null on HTTP 206.
integer
required
Total response time in milliseconds (data fetch + LLM + response assembly).
string
required
ISO 8601 timestamp of the response.

Signal Vocabulary

Each endpoint segment uses a specific set of signals:

HTTP Status Codes


Request Methods

All endpoints support both GET and POST:
Parameters in the JSON body. Preferred for x402 compatibility.

OpenAPI Specification

The full OpenAPI 3.1 spec is available at:
It includes x-payment-info extensions for every endpoint with pricing, network details, and facilitator URLs.