HTTP
Call a custom HTTP endpoint from a workbench
The HTTP tool turns one HTTP endpoint into a tool the workbench agent can call. You fix the URL, method, and headers when you configure the tool, describe the arguments the agent may supply with a JSON schema, and optionally write a request body template that Plural renders from those arguments. Use it for internal APIs and other endpoints that no dedicated Plural integration covers.
In Console, this integration appears as the Custom card. For the complete list of integrations and general tool behavior, see Workbench tools.
Prerequisites
Before you begin, make sure you have:
- An HTTP endpoint that Plural Console can reach over the network.
- Credentials for that endpoint, if it requires authentication, that can be sent as a static request header, such as a bearer token, a Basic authorization value, or an API key header.
- Permission in Plural Console to create a configured tool and edit the target workbench.
- An existing workbench, or permission to create one. See Setting up a workbench.
Prepare credentials
Create credentials for a dedicated integration account rather than a personal one. Prefer read-only roles or scopes, and restrict the account to the endpoints and resources this tool needs. The agent can call the tool with any arguments your input schema allows, so the credentials define the limit of what it can do.
Capabilities
Each configured HTTP tool gives the agent one operation, http_integration. The agent sees it with a description that names the tool, its method, and its URL, for example The orders HTTP integration tool, which makes a GET request to https://api.example.com/orders/search with the given input. Use a tool name and schema descriptions that tell the agent when to call it and what each argument means.
When the agent calls the tool: