CH·02CLI reference

deeprelay quota search-overflow

Show or set paid web-search overflow (on|off)

Synopsis

Shows or changes whether web searches can continue past your plan's monthly search allowance, with each extra search billed to your credit balance. The setting is per organization and is off by default.

deeprelay quota search-overflow shows the current setting.
deeprelay quota search-overflow on turns paid overflow on.
deeprelay quota search-overflow off turns it off again.

Any other argument is refused before anything is sent to the server.

What is billed

With overflow off, a search after the allowance is used up does not fail the request: the model receives a result saying the allowance is spent and when it resets, and the turn continues without it.

With overflow on, each search past the allowance is billed to your balance at deeprelay's cost. The Overflow price row shows the current figure, read from the server: currently $1.00 per 1,000 searches. It is an admin setting that follows the search provider's price, so check this command rather than relying on the figure here. This is separate from, and lower than, the pay-as-you-go search price described in the API guide's Web search section, which applies only to requests that are not covered by a plan. Only the search fee is billed: the request's tokens always stay on the plan, and search result text the model reads still counts as input tokens against your plan meters.

Every overflow search is admitted through the same checks as any pay-as-you-go spend: your credit balance, the organization's spending limits, the key's budget and the member's limit. If any of them refuses, the search returns the allowance-exhausted result to the model instead, and nothing is billed for it.

The fee appears on the request it belongs to. deeprelay requests get shows it as the Search overflow fee line, next to Web searches and Overflow searches. In -o json the field is search_overflow_fee_micro_cents, and deeprelay requests export carries it in the search_overflow_fee column.

Who can change it

Changing the setting requires an org admin, or a full_access key. Anything else fails with changing the search overflow setting requires org admin or a full_access key and exits 1. Any key can read the setting. Every change is recorded in the organization's audit log with its before and after values. On success the saved setting is printed in the same layout as the bare command.

Output

Paid search overflow  off
Overflow price        $1.00 per 1,000 searches (at cost)
Updated               never (default: off)

When the monthly search allowance is used up, further searches are billed to your balance at cost: currently $1.00 per 1,000 searches, separate from the pay-as-you-go search price. Tokens always stay on the plan.

Updated reads never (default: off) until someone saves the setting. -o json prints the server's fields as they are: overflow_enabled, updated_at, overflow_price_micro_cents (the per-search price in micro-cents), overflow_usd_per_thousand and note.

Examples

# Is paid search overflow on for my organization?
deeprelay quota search-overflow

# Let searches continue past the monthly allowance, billed to the balance
deeprelay quota search-overflow on

# Stop billing overflow searches
deeprelay quota search-overflow off

deeprelay quota search-overflow [on|off] [flags]

Options

  -h, --help   help for search-overflow

Options inherited from parent commands

      --api-base string   API base URL (override with DEEPRELAY_API_BASE env) (default "https://api.deeprelay.ai/v1")
      --debug             Enable debug logging to stderr
      --no-preflight      Skip the plan/credit check before inference requests (override with DEEPRELAY_NO_PREFLIGHT env)
  -o, --output string     Output format: table|json (default table on TTY, json otherwise) (default "table")