Skip to content

call

Inspect the API with docs first. Use its route slug and required parameters:

Terminal window
agent-data call <api-reference> <route-slug> --<parameter> <value> --dry-run
agent-data call <api-reference> <route-slug> --<parameter> <value>

Replace the placeholders with the values in the API’s current contract. Parameters depend on the endpoint. The CLI resolves the route’s method and sends inputs in the form its contract specifies.

--dry-run resolves and displays the planned request without invoking the data endpoint. It may read API documentation to resolve the route. Check the URL, method, and inputs before removing the flag.

OptionMeaning
--method <method>Select a method when the route requires an explicit choice.
--dry-runPreview the request without executing the endpoint.
--api-key <key>Override the configured API key. Prefer saved configuration or an environment secret.
--base-url <url>Override the marketplace service URL for a configured environment.

Calls use your account’s included allowance or credits. Check account for the current balance and usage controls for budget and recharge settings.

If the API rejects a parameter, re-read the contract and correct the input. If the source is unavailable or the API is degraded, inspect the dashboard’s health status before retrying. See troubleshooting.