List Tool Configurations API Definition
The List Tool Configurations API enables you to retrieve all tool configurations for a specific tool with optional filtering and pagination. Organizations use this API to discover existing configurations that can be reused across agents, ensuring consistency and reducing duplication when setting up new agents with standardized tool behaviors.
List Tool Configurations Request and Response
To list tool configurations, send a GET request to /v2/tools/{tool_id}/configurations. You can specify the following optional query parameters:
filter(string, optional): Regular expression to filter by name or description.type(string, optional): Filter by configuration type (e.g.,mcp,corpora_search,web_search).enabled(boolean, optional): Filter by enabled status.limit(integer, optional): Maximum configurations to return (1-100, default: 10).page_key(string, optional): Pagination key for retrieving the next page.
The response includes an array of tool configurations matching the filter criteria, along with pagination metadata if applicable.
Example Request
EXAMPLE REQUEST
1
Example Response
EXAMPLE RESPONSE
1
Error Responses
The API returns standard HTTP error codes with detailed error information:
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | invalid_request | Invalid filter parameters or malformed request |
| 401 | unauthorized | Invalid or missing API key |
| 403 | forbidden | Insufficient permissions for listing tool configurations |
| 404 | not_found | Specified tool not found |
| 429 | rate_limit_exceeded | Request rate limit exceeded |