POST /tools/probe
Validate candidate parameters and obtain a zero-cost quote before Call. The M1 schema and quote checks are implemented; coverage and sample return an explicit unknown verdict. Probe never executes the capability or consumes credits.
REST API overview · OpenAPI JSON · OpenAPI YAML
| Stability | Authentication | Cost | Operation ID |
|---|---|---|---|
| Published | Bearer API key | Free | probe_tool_api_v1_tools_probe_post |
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
tool_id | query | Yes | string | Tool ID to validate |
Schema: PublicToolProbeRequest
| Name | Required | Type | Description |
|---|---|---|---|
parameters | No | object | Candidate parameters to validate without executing the capability. |
checks | No | "schema" | "quote" | "coverage" | "sample"[] | — |
live_budget | No | "none" | "metadata" | "sampled" | M1 is zero-cost; every value avoids an upstream tool execution. |
curl --request POST \
--url "https://qveris.ai/api/v1/tools/probe?tool_id=string" \
--header "Authorization: Bearer $QVERIS_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"parameters": {
"q": "London"
},
"checks": [
"schema",
"quote"
],
"live_budget": "none"
}'
const response = await fetch("https://qveris.ai/api/v1/tools/probe?tool_id=string", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.QVERIS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"parameters": {
"q": "London"
},
"checks": [
"schema",
"quote"
],
"live_budget": "none"
}),
})
if (!response.ok) throw new Error(`QVeris request failed: ${response.status}`)
console.log(await response.json())
import json
import os
import requests
response = requests.request(
"POST",
"https://qveris.ai/api/v1/tools/probe?tool_id=string",
headers={"Authorization": f"Bearer {os.environ['QVERIS_API_KEY']}"},
json=json.loads(r'''{
"parameters": {
"q": "London"
},
"checks": [
"schema",
"quote"
],
"live_budget": "none"
}'''),
timeout=30,
)
response.raise_for_status()
print(response.json())
| Status | Meaning | Schema |
|---|---|---|
200 | Successful Response | PublicToolProbeResponse |
400 | Invalid probe request | PublicApiError |
401 | Unauthorized | PublicApiError |
404 | Capability not found | PublicApiError |
422 | Validation Error | HTTPValidationError |
429 | Too Many Requests | unknown |
502 | Upstream unavailable | PublicApiError |
504 | Upstream timeout | PublicApiError |
{
"schema": {
"valid": true
},
"quote": {
"estimate_credits": 5,
"currency": "credits",
"exact": true,
"basis": "per_call"
}
}
POST Discover capabilities · POST Inspect capabilities · POST Call a capability
Was this page helpful?