Toolkits
Custom API
CustomApiTools enable an Agent to make HTTP requests to any external API with customizable authentication and parameters.
Prerequisites
The following example requires the requests
library.
Example
The following agent will use CustomApiTools to make API calls to the Dog CEO API.
cookbook/tools/custom_api_tools.py
Toolkit Params
Parameter | Type | Default | Description |
---|---|---|---|
base_url | str | None | Base URL for API calls |
username | str | None | Username for basic authentication |
password | str | None | Password for basic authentication |
api_key | str | None | API key for bearer token authentication |
headers | Dict[str, str] | {} | Default headers to include in requests |
verify_ssl | bool | True | Whether to verify SSL certificates |
timeout | int | 30 | Request timeout in seconds |
make_request | bool | True | Whether to register the make_request function |
Toolkit Functions
Function | Description |
---|---|
make_request | Makes an HTTP request to the API. Takes method (GET, POST, etc.), endpoint, and optional params, data, headers, and json_data parameters. |