search_api_collections
Search for API collections using natural language semantic search.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query_key_word | string | Yes | Natural language search query |
client_id | string | Yes | Your client identifier |
api_key | string | Yes | Your API secret |
Response
Returns a formatted string with matching collections and similarity scores.Example
Input:Notes
- Results are filtered to collections you have access to
- Similarity scores range from 0 to 1 (higher is better)
- Maximum 10 results returned by default
get_openapi_spec
Retrieve the OpenAPI specification for a collection.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
collection_name | string | Yes | Name of the collection (from search results) |
client_id | string | Yes | Your client identifier |
api_key | string | Yes | Your API secret |
Response
Returns the OpenAPI specification as a JSON string.Example
Input:Notes
- Collection name matching is case-insensitive
- The full OpenAPI spec is returned, including all endpoints
- Use this to understand available operations before executing
execute_api
Execute an API request against a registered collection.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
collection_name | string | Yes | Target collection name |
method | string | Yes | HTTP method (GET, POST, PUT, DELETE, PATCH) |
endpoint | string | Yes | API endpoint path |
headers | string | No | JSON string of additional headers |
query_params | string | No | JSON string of query parameters |
path_params | string | No | JSON string of path parameters |
request_data | string | No | JSON string of request body |
client_id | string | Yes | Your client identifier |
api_key | string | Yes | Your API secret |
Response
Returns the API response as a JSON string.Example
Input:Path Parameters
For endpoints with path parameters like/users/{id}:
{id} placeholder will be replaced with user_123.
Error Responses
All tools return errors in a consistent format:Common Errors
| Error | Cause | Solution |
|---|---|---|
Collection not found | Invalid collection name | Use search to find correct name |
Access denied | No permission for collection | Request access from admin |
Invalid request | Malformed parameters | Check JSON formatting |
Best Practices
Search before executing
Search before executing
Always use
search_api_collections first to find the correct collection name and verify you have access.Check the spec
Check the spec
Use
get_openapi_spec to understand available endpoints, required parameters, and expected responses before executing.Handle errors gracefully
Handle errors gracefully
Always check for error responses before proceeding with subsequent calls.
Use idempotency keys
Use idempotency keys
For POST requests that create resources, include an idempotency key in headers to prevent duplicates.

