Metadata

Get capability catalog

Returns a machine-readable catalog of rateAPI's agent-buildable surface: each capability maps a real-world flow (institution discovery, rate shopping/comparison, affordability, refinance, monitoring/alerts, deposit/ALM) to the REST route an agent calls and the corresponding MCP tool, along with required/optional inputs and the minimum tier.

This is the foundation for an agent skills library. REST routes are derived from this OpenAPI spec, so the catalog cannot drift from the live API.

No authentication required.

get/v1/capabilities

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/capabilities
  • Auth: none required

Response

Capability catalog

versioninteger

Schema version of this catalog.

generatedAtstring date-time

When this catalog was generated.

flowsstring[]

Every flow the capabilities are grouped into.

countinteger

Number of capabilities in the catalog.

Example response

{
  "version": 1,
  "flows": [
    "institution/discovery",
    "shopping/comparison",
    "affordability",
    "refinance",
    "monitoring/alerts",
    "deposit/ALM"
  ],
  "count": 12,
  "capabilities": [
    {
      "id": "refinance-break-even",
      "flow": "refinance",
      "route": {
        "method": "POST",
        "path": "/v1/refinance-break-even",
        "operationId": "refinanceBreakEven"
      },
      "mcpTool": "refinance_break_even"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.