Skip to the content
Rhumb
Menu

DocsStart

Quickstart

Create a key and resolve your first model.

Three steps from nothing to a model your code can call. No SDK to install: every step is one HTTPS request.

  1. Create a key

    Create a free account, confirm your email, then create a key under API keys. It is shown once: store it as RHUMB_KEY in your server's secrets.

  2. Resolve a model

    Ask which model to call for your need on your providers. The TypeScript, Python and Rust versions cache the answer for a day, time out after two seconds and fall back to a model you choose.

    resolve.sh
    #!/usr/bin/env bash
# Resolve a model with curl: which model on Gemini or OpenAI reads receipts best
# for the price? Prints the JSON answer; `model.provider_model_id` is the name to
# pass to the provider's API.
#
#   RHUMB_KEY=nnm_live_... bash resolve.sh
#
# RHUMB_URL overrides the base URL (default https://rhumbdata.com).
set -euo pipefail

: "${RHUMB_KEY:?Set RHUMB_KEY to your nnm_live_ key}"
RHUMB_URL="${RHUMB_URL:-https://rhumbdata.com}"

curl --silent --show-error --fail-with-body --max-time 10 \
  "$RHUMB_URL/v1/resolve?purpose=read-receipts&providers=gemini,openai" \
  -H "Authorization: Bearer $RHUMB_KEY"
echo

  3. Call the model it names

    Use model.provider and model.provider_model_id with that provider's own SDK and your own provider key. also_on lists the same model on your other providers, ready as a fallback.

Next