GET /v1/tools/:id
The full contract of one tool: input schema, one-of field sets, notes, an example input, today's price and hold, timeout and how to run it. The same view inspect_tool shows over MCP. Free.
GET https://api.parel.si/v1/tools/:id
Any valid key. Free. :id is the tool name. A name that does not exist or is switched off answers unknown_tool (404).
curl https://api.parel.si/v1/tools/get_reddit -H "Authorization: Bearer $PAREL_KEY"
Response
ok: true and tool, with every field of a discover row plus:
| Field | Type | Description |
|---|---|---|
notes | string[] | Quirks: rate limits, slow calls, empty-result rules, response size |
input_schema | object | JSON Schema for input: properties with types and descriptions, required, and anyOf for one-of sets |
one_of | string[][] or null | The alternative field sets of which one must be complete |
example_input | object | A valid input, checked against the schema |
hold_paise | integer | The worst-case hold at today's rate |
count_field, count_note | string | Only for per-result tools: which input field the hold is priced on, and the billing step |
timeout_seconds | integer | After which the call is upstream_timeout, ₹0 |
how_to_run | string | "Call the … tool directly." for a headline MCP tool, else "Call run_tool with tool: … " |
confirm_required | boolean | Whether every input needs confirm: true |
confirm_threshold_paise, how_to_confirm | integer, string | Only when confirmation applies |
quote | string | A reminder that quote_tool / POST /v1/quote gives the estimated charge for an input |
The input tables on every tool page are generated from this response, captured from staging. Captured for get_reddit:
{
"ok": true,
"tool": {
"name": "get_reddit",
"summary": "Posts from one subreddit: title, score, comments count, text; hot, new, top or rising.",
"description": "Posts from one subreddit by name (without r/): title, author, score, comment count, flair, created time, link and post text, sorted hot (default), new, top or rising. Use it to read what a community is discussing. It does not search across Reddit, does not return a post's comments, and cannot read private subreddits; for a keyword search across the web use search_web, for news use search_news. Flat price per call, about 25 posts. India: r/india, r/IndiaInvestments, r/bangalore and other city subreddits work well; names are case-insensitive. ~₹0.28 per call. ₹0 if it fails or finds nothing.",
"price": "~₹0.28 per call",
"estimated_cost_paise": 28,
"estimated_cost": "₹0.28",
"async": false,
"free_when_no_result": true,
"confirm_required": false,
"notes": [
"About 25 posts per call, around 30 KB.",
"sort: hot, new, top, rising.",
"A banned or private subreddit returns nothing, which is free."
],
"input_schema": {
"type": "object",
"required": [
"subreddit"
],
"properties": {
"sort": {
"type": "string",
"description": "Sort order"
},
"subreddit": {
"type": "string",
"description": "Subreddit name. e.g. \"news\""
}
}
},
"one_of": null,
"example_input": {
"sort": "hot",
"subreddit": "IndiaInvestments"
},
"hold_paise": 42,
"timeout_seconds": 30,
"how_to_run": "Call run_tool with tool: \"get_reddit\" and input matching input_schema.",
"quote": "Call quote_tool with this tool and your input to see the estimated charge and the hold before running it."
}
}
This page as Markdown: /docs/api/tool.md. Something wrong or missing: hello@parel.si.