> To find and run AgentRouter tools, connect to https://mcp.agentrouter.to/. To search this documentation, use https://docs.agentrouter.to/_mcp/server. Append .md to a page URL for Markdown. For the documentation index, see https://docs.agentrouter.to/llms.txt.

# Find tools for a task

POST https://api.agentrouter.to/v1/find
Content-Type: application/json

Multilingual semantic and keyword search over enabled tools. Returns candidates with a fit label, required
inputs, current price summary and observed health. Tools in an outage are hidden
unless `include_unavailable` is true. Free; anonymous callers are allowed.


Reference: https://docs.agentrouter.to/api-reference/agent-router-api/discovery/find

## Authentication

- `Authorization` header (bearer token, required) — An AgentRouter API key or an OAuth access token issued to an MCP host or the CLI.

## Request

### Body (application/json)

This endpoint expects a FindRequest.

- `query` (string, required) — Short task description.
- `category_ids` (list of string, optional) — Match any registered second-level category.
- `group_ids` (list of string, optional) — Match any registered top-level group.
- `limit` (integer, optional, default: 10)
- `provider` (string, optional) — Only tools from this provider id.
- `tags` (list of string, optional) — Only tools that carry every tag.
- `include_unavailable` (boolean, optional, default: false) — Include tools in an outage.

## Response

### 200

Candidate tools (possibly none)

- `object` (any, required)
- `query` (string, required)
- `match` (enum, required)
  - Allowed values: `exact`, `partial`, `none`
- `tools` (list of FoundTool, required)
- `hints` (list of Hint, required)

## Errors

### 400 Bad Request Error

Invalid request (for example INVALID_REQUEST, INPUT_INVALID, PRICING_VERSION_REQUIRED, PRICE_NOT_CLIENT_SETTABLE). Nothing was executed.

- `error` (ErrorError, required)
- `run` (Run, optional) — The receipt for one invocation. Run status, provider outcome and billing are separate facts.

### 401 Unauthorized Error

Missing or invalid credential (UNAUTHENTICATED, INVALID_CREDENTIAL)

- `error` (ErrorError, required)
- `run` (Run, optional) — The receipt for one invocation. Run status, provider outcome and billing are separate facts.

## Types

### FoundTool

- `category_ids` (list of string, required)
- `group_ids` (list of string, required)
- `tool_id` (string, required)
- `title` (string, required)
- `provider` (string, required)
- `summary` (string, required)
- `fit` (enum, required)
  - Allowed values: `exact`, `partial`
- `matched_terms` (list of string, required) — Literal matches. May be empty for semantic matches.
- `required_inputs` (list of string, required)
- `executable` (boolean, required)
- `price` (Price, required)
- `health` (HealthSummary, required)

### Hint

- `code` (string, required) — Machine-readable next step, e.g. POLL_RUN, DESCRIBE_TOOL, TOP_UP, NEXT_PAGE.
- `message` (string, required)
- `params` (map from string to any, optional)

### ErrorError

- `code` (string, required)
- `message` (string, required)
- `hints` (list of Hint, required)
- `details` (map from string to any, required)

### Run

The receipt for one invocation. Run status, provider outcome and billing are separate facts.

- `object` (any, required)
- `run_id` (string, required)
- `status` (enum, required)
  - Allowed values: `READY`, `RUNNING`, `STOPPING`, `COMPLETED`, `FAILED`, `BLOCKED`, `STOPPED`, `TIMED_OUT`
- `tool_id` (string, required)
- `tool_version` (string, required)
- `provider` (string, required)
- `input` (any, required) — The submitted tool input
- `session_id` (string, required, nullable)
- `caller` (RunCaller, required)
- `channel` (enum, required)
  - Allowed values: `http`, `cli`, `mcp`, `web`
- `created_at` (string, required, nullable)
- `started_at` (string, required, nullable)
- `completed_at` (string, required, nullable)
- `latency_ms` (integer, required, nullable)
- `replayed` (boolean, required) — True when an idempotency key returned an existing run.
- `stoppable` (boolean, required)
- `provider_response` (RunProviderResponse, required)
- `error` (RunError, required, nullable)
- `billing` (RunBilling, required)
- `result` (RunResult, required)
- `next_cursor` (string, required, nullable) — Pass back as the tool's cursor input for the next page (a new billed call).
- `hints` (list of Hint, required)
- `output` (any, required) — The provider's output exactly as returned

### Price

- `pricing_version` (string, required, nullable) — Pass to invoke. Null while the price is pending (not executable).
- `basis` (enum, required) — `units` bills provider units at a rate; `upstream_usd` bills the provider-reported cost.
  - Allowed values: `units`, `upstream_usd`
- `unit` (string, required) — Usage unit, e.g. credit, request, usd.
- `price_multiplier` (string, required, nullable) — Single multiplier on the base price: "1" list price, "0.5" half price, "1.2", or "0" free.
- `multiplier_label` (string, required, nullable)
- `free` (boolean, required) — True when pricing is confirmed and max_per_call_usd is "0" for every supported input. A single free result does not make a tool free.
- `max_per_call_usd` (string, required, nullable) — Customer charge ceiling that applies across inputs at this price. "0" guarantees a free call. Null means the ceiling depends on input or pricing is pending.
- `summary` (string, required)
- `status` (enum, required)
  - Allowed values: `confirmed`, `pending`
- `unit_price_usd` (string, optional, nullable) — Customer rate per usage unit after the current multiplier. A free call can consume zero units at a positive rate. Null for provider-reported or unconfirmed rates.
- `image_sample` (PriceImageSample, optional) — Illustrative price for one image at the stated usage and current customer rates, before a conditional image offer.
- `image_offer` (PriceImageOffer, optional) — Active discount on the entire call when the final delivered image meets the pixel threshold. Already included at settlement.
- `image_pricing` (PriceImagePricing, optional) — Effective customer price per output image at each supported tier.
- `video_pricing` (PriceVideoPricing, optional) — Effective customer video rates. The sample uses the first tier without reference footage. An equivalent per-second rate for a fixed clip is approximate.

### HealthSummary

- `status` (enum, required)
  - Allowed values: `unknown`, `healthy`, `degraded`, `outage`
- `samples` (integer, required) — Finished calls excluding cancellations and blocked requests.
- `window_days` (integer, required)
- `success_rate` (double, required, nullable)
- `window` (HealthWindow, required)
- `computed_at` (datetime, required)

### RunCaller

- `type` (enum, required)
  - Allowed values: `api_key`, `oauth`, `session`
- `name` (string, required)

### RunProviderResponse

- `http_status` (integer, required, nullable)
- `outcome` (enum, required)
  - Allowed values: `success`, `empty`, `provider_error`, `pending`
- `status` (string, required, nullable)
- `request_id` (string, required, nullable)
- `task_id` (string, required, nullable)

### RunError

- `code` (string, required)
- `message` (string, required)
- `origin` (enum, required)
  - Allowed values: `provider`, `platform`, `client`
- `retryable` (boolean, required, nullable)
- `details` (RunErrorDetails, optional, nullable) — Sanitized provider error evidence. Absent for old runs and errors without an upstream response.

### RunBilling

- `status` (enum, required)
  - Allowed values: `none`, `reserved`, `settled`, `refunded_partial`, `refunded_full`
- `reason` (enum, required) — Why the charge is what it is. A zero charge always carries a reason.
  - Allowed values: `charged`, `charged_capped`, `free_promotion`, `zero_base`, `waived_provider_error`, `waived_platform_error`, `waived_empty_result`, `waived_stopped`, `waived_timeout`, `waived_unknown_cost`, `blocked_before_execution`
- `currency` (any, required)
- `pricing_version` (string, required)
- `price_multiplier` (string, required, nullable)
- `promotion_id` (string, required, nullable)
- `max_cost_usd` (string, required) — Exact USD amount as a decimal string.
- `reserved_usd` (string, required) — Exact USD amount as a decimal string.
- `base_charge_usd` (string, required, nullable) — Price before the multiplier.
- `customer_charge_usd` (string, required) — Exact USD amount as a decimal string.
- `customer_refund_usd` (string, required) — Exact USD amount as a decimal string.
- `net_charge_usd` (string, required) — Exact USD amount as a decimal string.
- `charge_is_new` (boolean, required) — False on an idempotent replay; nothing new was charged.
- `usage` (RunBillingUsage, required, nullable)

### RunResult

- `available` (boolean, required)
- `expired` (boolean, required) — True when a previously stored result has expired or is no longer present.
- `bytes` (integer, required, nullable)
- `expires_at` (string, required, nullable)
- `url` (string, required, nullable) — GET this to download the stored output; it never re-runs the tool.
- `inline` (boolean, required) — False when the output is too large to include; download it from url.

### PriceImageSample

Illustrative price for one image at the stated usage and current customer rates, before a conditional image offer.

- `width` (integer, required)
- `height` (integer, required)
- `usage` (string, required)
- `usd` (string, required)

### PriceImageOffer

Active discount on the entire call when the final delivered image meets the pixel threshold. Already included at settlement.

- `percent_off` (integer, required)
- `min_delivered_pixels` (integer, required)
- `ends_at` (datetime, required) — Exclusive cutoff.
- `sample_usd` (string, optional) — Discounted customer amount for image_sample when that sample qualifies.

### PriceImagePricing

Effective customer price per output image at each supported tier.

- `rates` (list of PriceImagePricingRatesItems, required)

### PriceVideoPricing

Effective customer video rates. The sample uses the first tier without reference footage. An equivalent per-second rate for a fixed clip is approximate.

- `unit` (enum, required)
  - Allowed values: `clip`, `second`
- `sample_seconds` (integer, required)
- `sample_usd` (string, required)
- `rates` (list of PriceVideoPricingRatesItems, required)
- `reference_billing` (string, optional)

### HealthWindow

- `from` (datetime, required) — Inclusive window start.
- `to` (datetime, required) — Exclusive window end.
- `time_basis` ("completed_at", required)

### RunErrorDetails

Sanitized provider error evidence. Absent for old runs and errors without an upstream response.

- `body` (string, required) — Provider response JSON text with credentials and internal pricing fields redacted; non-JSON bodies are omitted. Limited to 20000 characters.
- `truncated` (boolean, required) — True when only a prefix of the sanitized error was retained.

### RunBillingUsage

- `unit` (string, required)
- `quantity` (string, required, nullable)
- `status` (enum, required)
  - Allowed values: `known`, `none`, `unknown`

### PriceImagePricingRatesItems

- `label` (string, required)
- `usd_per_image` (string, required)

### PriceVideoPricingRatesItems

- `label` (string, required)
- `usd_per_second` (string, required)
- `usd_per_clip` (string, optional)

## Examples

**Request**

```json
{
  "query": "recent X posts about a company",
  "limit": 5
}
```

**Response**

```json
{
  "object": null,
  "query": "string",
  "match": "exact",
  "tools": [
    {
      "category_ids": [
        "string"
      ],
      "group_ids": [
        "string"
      ],
      "tool_id": "anyapi.twitter.search",
      "title": "string",
      "provider": "string",
      "summary": "string",
      "fit": "exact",
      "matched_terms": [
        "string"
      ],
      "required_inputs": [
        "string"
      ],
      "executable": true,
      "price": {
        "pricing_version": "string",
        "basis": "units",
        "unit": "string",
        "price_multiplier": "string",
        "multiplier_label": "string",
        "free": true,
        "max_per_call_usd": "string",
        "summary": "string",
        "status": "confirmed",
        "unit_price_usd": "string",
        "image_sample": {
          "width": 1,
          "height": 1,
          "usage": "string",
          "usd": "string"
        },
        "image_offer": {
          "percent_off": 1,
          "min_delivered_pixels": 1,
          "ends_at": "2024-01-15T09:30:00Z",
          "sample_usd": "string"
        },
        "image_pricing": {
          "rates": [
            {
              "label": "string",
              "usd_per_image": "string"
            }
          ]
        },
        "video_pricing": {
          "unit": "clip",
          "sample_seconds": 1,
          "sample_usd": "string",
          "rates": [
            {
              "label": "string",
              "usd_per_second": "string",
              "usd_per_clip": "string"
            }
          ],
          "reference_billing": "string"
        }
      },
      "health": {
        "status": "unknown",
        "samples": 1,
        "window_days": 1,
        "success_rate": 0.5,
        "window": {
          "from": "2024-01-15T09:30:00Z",
          "to": "2024-01-15T09:30:00Z",
          "time_basis": "string"
        },
        "computed_at": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "hints": [
    {
      "code": "string",
      "message": "string",
      "params": {}
    }
  ]
}
```

**SDK Code**

```python Discovery_find_example
import requests

url = "https://api.agentrouter.to/v1/find"

payload = {
    "query": "recent X posts about a company",
    "limit": 5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Discovery_find_example
const url = 'https://api.agentrouter.to/v1/find';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"query":"recent X posts about a company","limit":5}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Discovery_find_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentrouter.to/v1/find"

	payload := strings.NewReader("{\n  \"query\": \"recent X posts about a company\",\n  \"limit\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Discovery_find_example
require 'uri'
require 'net/http'

url = URI("https://api.agentrouter.to/v1/find")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"recent X posts about a company\",\n  \"limit\": 5\n}"

response = http.request(request)
puts response.read_body
```

```java Discovery_find_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.agentrouter.to/v1/find")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"recent X posts about a company\",\n  \"limit\": 5\n}")
  .asString();
```

```php Discovery_find_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.agentrouter.to/v1/find', [
  'body' => '{
  "query": "recent X posts about a company",
  "limit": 5
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Discovery_find_example
using RestSharp;

var client = new RestClient("https://api.agentrouter.to/v1/find");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"query\": \"recent X posts about a company\",\n  \"limit\": 5\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Discovery_find_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "query": "recent X posts about a company",
  "limit": 5
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentrouter.to/v1/find")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```