Authentication

Provision a sandbox or credit key for testing

Two paths: (1) Email path — POST with { "email": "..." } to get a sb_ sandbox key (7 days, 200 calls). One key per email/IP per 7-day window. (2) x402 agent path — POST with X-Payment header containing a valid Base mainnet USDC payment ($0.001). Skips email entirely; returns a ho_crd_ credit key with 10 credits. Agent-native: no human in the loop. Sandbox keys are rejected by /v5/receipts and /v5/webhooks/subscribe (paid features).

post/v5/sandbox

Request

Base URL: https://headlessoracle.com
URL: https://headlessoracle.com/v5/sandbox
Auth: none declared

Headers

X-Paymentstring

x402 payment proof (JSON). When present, skips email verification and issues a credit key. Format: { "txHash": "0x...", "network": "base", "amount": "1000", "paymentAddress": "0x...", "memo": "" }

Request body

emailstring email

Required for email path. Omit when using X-Payment header.

use_casestring

Brief description of what you're building (helps us prioritise).

Example request

{
  "email": "developer@example.com"
}

Response

Key issued (sandbox or credit)

api_keystring

tier'sandbox' | 'credits'

email_capturedboolean

expires_atstring date-time

calls_remaininginteger

creditsinteger

Credit balance (x402 path only).

upgrade_urlstring

quickstartobject

Example response

{
  "api_key": "sb_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.