POST /tools/by-ids
Fetch full capability metadata for one or more tool ids. Inspect is free and returns the same capability shape as Discover, including parameter schema, examples, quality signals, and cost estimates.
REST API overview · OpenAPI JSON · OpenAPI YAML
| Stability | Authentication | Cost | Operation ID |
|---|---|---|---|
| Published | Bearer API key | Free | get_tools_by_ids_api_v1_tools_by_ids_post |
This operation has no path or query parameters.
Schema: PublicToolsByIdsRequest
| Name | Required | Type | Description |
|---|---|---|---|
tool_ids | Yes | string[] | Capability ids returned by Discover. |
search_id | No | string | Search id that returned these capabilities, when available. |
session_id | No | string | Optional tracking and pricing-context identifier. It does not promise a cache hit. |
view | No | "full" | "lean" | Response projection. lean trims per-capability metadata for model context; full or omitted returns the complete result shape. |
curl --request POST \
--url "https://qveris.ai/api/v1/tools/by-ids" \
--header "Authorization: Bearer $QVERIS_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"tool_ids": [
"openweathermap.weather.execute.v1"
],
"search_id": "srch_01HZX9QK7J3M9T",
"session_id": "sess_7Q9m"
}'
const response = await fetch("https://qveris.ai/api/v1/tools/by-ids", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.QVERIS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"tool_ids": [
"openweathermap.weather.execute.v1"
],
"search_id": "srch_01HZX9QK7J3M9T",
"session_id": "sess_7Q9m"
}),
})
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/by-ids",
headers={"Authorization": f"Bearer {os.environ['QVERIS_API_KEY']}"},
json=json.loads(r'''{
"tool_ids": [
"openweathermap.weather.execute.v1"
],
"search_id": "srch_01HZX9QK7J3M9T",
"session_id": "sess_7Q9m"
}'''),
timeout=30,
)
response.raise_for_status()
print(response.json())
| Status | Meaning | Schema |
|---|---|---|
200 | Successful Response | PublicInspectResponse |
401 | Unauthorized | PublicApiError |
429 | Too Many Requests | unknown |
504 | Upstream timeout | PublicApiError |
{
"search_id": "srch_01HZX9QK7J3M9T",
"total": 1,
"results": [
{
"tool_id": "openweathermap.weather.execute.v1",
"name": "Current Weather",
"description": "Get current weather data for a city.",
"provider_name": "OpenWeatherMap",
"params": [
{
"name": "q",
"type": "string",
"required": true,
"description": "Location query accepted by the weather provider."
}
],
"examples": {
"sample_parameters": {
"q": "London"
}
},
"expected_cost": "5 credits per successful request",
"billing_rule": {
"unit": "request",
"amount_credits": 5
},
"stats": {
"avg_execution_time_ms": 210.7,
"success_rate": 0.982
}
}
],
"remaining_credits": 995
}
POST Discover capabilities · POST Probe a capability · POST Call a capability
Was this page helpful?