HTTP Source

The HTTP source enables the Toolbox to retrieve data from a remote server using HTTP requests.

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 NameDescription
http ToolA "http" tool sends out an HTTP request to an HTTP endpoint.

Example

kind: sources
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
# disableSslVerification: false

Tip

Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.

Reference

fieldtyperequireddescription
typestringtrueMust be “http”.
baseUrlstringtrueThe base URL for the HTTP requests (e.g., https://api.example.com).
timeoutstringfalseThe timeout for HTTP requests (e.g., “5s”, “1m”, refer to ParseDuration for more examples). Defaults to 30s.
headersmap[string]stringfalseDefault headers to include in the HTTP requests.
queryParamsmap[string]stringfalseDefault query parameters to include in the HTTP requests.
disableSslVerificationboolfalseDisable SSL certificate verification. This should only be used for local development. Defaults to false.