api.searchEndpoints
Search API documentation by query, tag, or method to retrieve path, parameters, request body, and success responses. Use to quickly locate endpoints or test missing schemas with 'api.request'.
Instructions
Semantic API documentation search returning essential info: path, method, params (GET), request body (POST/PUT/PATCH/DELETE), and success responses. If schemas are missing, suggests using 'api.request' for live testing.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
limit | No | Maximum number of endpoints to return (default: 10) | |
maxResults | No | [DEPRECATED] Use 'limit' instead. | |
method | No | Filter results by HTTP method (optional) | |
query | No | Text query to match against path, summary, description, operationId, and tags | |
searchTerms | No | [DEPRECATED] Previous array of keywords. If provided, behaves like an OR search across terms. | |
tag | No | Filter by a specific tag (case-insensitive exact match) |