HTTP Source
The HTTP source enables the Toolbox to retrieve data from a remote server using HTTP requests.
less than a minute
About
The HTTP Source allows Toolbox to retrieve data from arbitrary HTTP endpoints. This enables Generative AI applications to access data from web APIs and other HTTP-accessible resources.
Available Tools
HTTP Source Tools
| Tool Name | Description |
|---|---|
| http | A "http" tool sends out an HTTP request to an HTTP endpoint. |
Example
kind: source
name: my-http-source
type: http
baseUrl: https://api.example.com/data
timeout: 10s # default to 30s
headers:
Authorization: Bearer ${API_KEY}
Content-Type: application/json
queryParams:
param1: value1
param2: value2
# returnFullError: false
# disableSslVerification: false
Tip
Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “http”. |
| baseUrl | string | true | The base URL for the HTTP requests (e.g., https://api.example.com). |
| timeout | string | false | The timeout for HTTP requests (e.g., “5s”, “1m”, refer to ParseDuration for more examples). Defaults to 30s. |
| headers | map[string]string | false | Default headers to include in the HTTP requests. |
| queryParams | map[string]string | false | Default query parameters to include in the HTTP requests. |
| returnFullError | bool | false | Include raw upstream response bodies in error messages for non-2xx responses. Defaults to false. |
| disableSslVerification | bool | false | Disable SSL certificate verification. This should only be used for local development. Defaults to false. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.