Describe one tool | AgentRouter | Developer Documentation

{
  "category_ids": [
    "string"
  ],
  "group_ids": [
    "string"
  ],
  "object": null,
  "tool_id": "string",
  "tool_version": "string",
  "title": "string",
  "description": "string",
  "provider": {
    "id": "string",
    "name": "string",
    "homepage": "string",
    "docs_url": "string"
  },
  "tags": [
    "string"
  ],
  "use_cases": [
    "string"
  ],
  "input_schema": {},
  "examples": [
    {
      "title": "string"
    }
  ],
  "output": {
    "description": "string"
  },
  "execution": {
    "mode": "sync",
    "stoppable": true,
    "max_duration_ms": 1,
    "long_running": true
  },
  "limits": {},
  "pagination": {},
  "executable": true,
  "pricing": {
    "pricing_version": "string",
    "basis": "units",
    "unit": "string",
    "price_multiplier": "string",
    "multiplier_label": "string",
    "free": true,
    "max_per_call_usd": "string",
    "summary": "string",
    "status": "confirmed",
    "effective_from": "2024-01-15T09:30:00Z",
    "effective_to": "string",
    "public_price": {
      "summary": "string",
      "sourceUrl": "string",
      "retrievedAt": "string"
    },
    "usage_unit": "string",
    "maximum_rule": "string",
    "promotion": {
      "promotion_id": "string",
      "ends_at": "string",
      "note": "string",
      "per_account_daily_calls": 1
    },
    "rules": {},
    "invoke_requires": [
      "string"
    ],
    "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"
    },
    "usage_evidence": null
  },
  "health": {
    "status": "unknown",
    "window_days": 1,
    "window": {
      "from": "2024-01-15T09:30:00Z",
      "to": "2024-01-15T09:30:00Z",
      "time_basis": "string"
    },
    "computed_at": "2024-01-15T09:30:00Z",
    "samples": 1,
    "counts": {
      "evaluated": 1,
      "completed": 1,
      "failed": 1,
      "timed_out": 1,
      "stopped": 1,
      "empty": 1,
      "provider_errors": 1,
      "platform_errors": 1
    },
    "success_rate": 0.5,
    "provider_error_rate": 0.5,
    "platform_error_rate": 0.5,
    "empty_rate": 1.1,
    "latency": {
      "basis": "string",
      "population": "string",
      "samples": 1,
      "method": "string",
      "p50_ms": 1.1,
      "p95_ms": 1.1
    },
    "last_success_at": "string",
    "p50_ms": 1.1,
    "p95_ms": 1.1
  },
  "alternatives": [
    {
      "tool_id": "string",
      "title": "string",
      "provider": "string"
    }
  ]
}

The tool’s input JSON Schema, examples, output description, execution mode, limits, pagination, price terms (including pricing_version, required by invoke), charge rules, health and related tools. Free; anonymous callers are allowed.

Authentication

AuthorizationBearer

An AgentRouter API key or an OAuth access token issued to an MCP host or the CLI.

Request

This endpoint expects an object.

tool_idstringRequired

Response

The tool contract

category_idslist of strings

group_idslist of strings

objectany

tool_idstring

tool_versionstring

titlestring

descriptionstring

providerobject

tagslist of strings

use_caseslist of strings

input_schemaobject

JSON Schema for input.

exampleslist of objects

outputobject

executionobject

limitsobject or null

paginationobject or null

executableboolean

pricingobject

healthobject

Finished logical calls in the window, across accounts and channels. Read on demand and cached for 60 seconds; never probes a provider.

alternativeslist of objects

Errors

400

Bad Request Error

404

Not Found Error