Quick first run#

New to QVeris? With your QVERIS_API_KEY set (create one at qveris.ai), one command walks the whole loop end to end — auth, discover, inspect, a real call, and the exact usage/ledger commands to reconcile billing — no install needed:

export QVERIS_API_KEY="sk-..."
npx @qverisai/cli init

Re-run anytime with --query "..." to target a different capability, or --dry-run to validate without consuming credits. Once you've seen the loop, the commands below are the day-to-day surface.

Commands#

# Discover tools by capability
qveris discover "weather forecast API" --json --limit 10
 
# Inspect tool details (optional)
qveris inspect 1 --json
 
# Call with parameters (use sample_parameters from discover/inspect)
qveris call 1 --params '{"wfo": "BOU", "x": 50, "y": 30}' --json
 
# Validate without consuming credits
qveris call 1 --params '{"wfo": "BOU", "x": 50, "y": 30}' --dry-run --json
 
# Generate production code snippet (curl/python/js) — only on successful calls
qveris call 1 --params '{"wfo": "BOU", "x": 50, "y": 30}' --codegen curl

Always use --json for structured output.

Response Size#

Default: 4KB (TTY) / 20KB (piped/--json). Use --max-size -1 for unlimited. Large responses are auto-truncated with a download link for the full result.

Session Mechanism#

Results are cached per discover. Use numeric indices immediately. If you run a new discover, indices reset to reference the new results.

Discover Query Formulation#

Describe tool capability, not data you want.

Always query in English.

Tool Selection#

Prefer tools with:

• success_rate >= 90%
• avg_execution_time_ms < 2000ms
• Higher final_score

Error Recovery#

1. Fix params based on error message
2. Simplify — drop optional params, use standard values
3. Switch to next tool from discover results

After 3 failures: report what was tried.