Api Call Tool
Tool used to call HTTP APIs.
Inputs
Inputs divide into public and private. Public input is for user's interaction with block. Private input is for communication between block and block. You can't use these inputs directly
| name | type | accessibility |
|---|---|---|
| args | text | Private |
Fields
| name | description | details |
|---|---|---|
| Name | The name of the block. Can only contain letters, numbers, and underscores. Cannot include spaces. | N/A |
| Method | The HTTP method to use for the request. | N/A |
| URL | The URL to send the request to. If you want to use a variable, use {{variable_name}}. Notice the double curly braces! | N/A |
| Description | The description of the API call. | N/A |
| Parameters | Valid JSONSchema definition of the parameters passed to api call. Always pass a JSON object schema. i.e. {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"]}. | N/A |
| Headers | Valid JSON object of the headers to be sent with the request. i.e. {"Content-Type": "application/json"}. | N/A |
| Authorize | Whether to authorize the request with organization secret. | Default: false |
Parameters interpolation
You can use parameters in the URL and headers fields.
To use a parameter specified in Parameters field, enclose it within {{}}. For example, if you have a parameter named id, you can use it in the URL as https://example.com/posts/{{id}}.
In order to inject secret or Metadata values, use {{secrets.secret_name}} or {{metadata.metadata_name}} respectively.