Tools - OpenRouter | Documentation

Overview

The catalog of server tools OpenRouter runs on behalf of a model: accepted tools[].type spellings per API format, engines and pricing, and which endpoints run each tool natively. See https://openrouter.ai/docs/guides/features/server-tools.

Available Operations

list_tools - List server tools
get_tool - Get a server tool

list_tools

Lists every server tool OpenRouter can run on behalf of a model: accepted tools[].type spellings per API format, the engines behind it with their pricing, and how many endpoints run it natively.

Example Usage

from openrouter import OpenRouter, operations
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
) as open_router:

    res = open_router.tools.list_tools(security=operations.ListToolsSecurity(
        bearer=os.getenv("OPENROUTER_BEARER", ""),
    ), offset=0, limit=50)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`security`	operations.ListToolsSecurity	:heavy_check_mark:	N/A
`http_referer`	Optional[str]	:heavy_minus_sign:	The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application.
`x_open_router_title`	Optional[str]	:heavy_minus_sign:	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`x_open_router_categories`	Optional[str]	:heavy_minus_sign:	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`offset`	OptionalNullable[int]	:heavy_minus_sign:	Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned	0
`limit`	Optional[int]	:heavy_minus_sign:	Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned	50
`api_format`	Optional[operations.APIFormat]	:heavy_minus_sign:	Only tools usable on this API format	responses
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

components.ListToolsResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.ForbiddenResponseError	403	application/json
errors.NotFoundResponseError	404	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

get_tool

One server tool by canonical name or any accepted alias, with the models that run it natively.

Example Usage

from openrouter import OpenRouter, operations
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
) as open_router:

    res = open_router.tools.get_tool(security=operations.GetToolSecurity(
        bearer=os.getenv("OPENROUTER_BEARER", ""),
    ), name="openrouter:web_search")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`security`	operations.GetToolSecurity	:heavy_check_mark:	N/A
`name`	str	:heavy_check_mark:	Canonical `openrouter:*` name or any accepted `tools[].type` alias	openrouter:web_search
`http_referer`	Optional[str]	:heavy_minus_sign:	The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application.
`x_open_router_title`	Optional[str]	:heavy_minus_sign:	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`x_open_router_categories`	Optional[str]	:heavy_minus_sign:	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

operations.GetToolResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.ForbiddenResponseError	403	application/json
errors.NotFoundResponseError	404	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

​Overview

​Available Operations

​list_tools

​Example Usage

​Parameters

​Response

​Errors

​get_tool

​Example Usage

​Parameters

​Response

​Errors

Overview

Available Operations

list_tools

Example Usage

Parameters

Response

Errors

get_tool

Example Usage

Parameters

Response

Errors