Run API
AI-generatedSummary
Send a request to run a specific API by its SKU with a structured or raw JSON input payload, optionally configuring output options.
Inputs
- API Name or ID (required) — Select the API to run by choosing from the listed SKUs or specifying an ID via expression.
- Input Mode (required) — Choose to supply input as individual typed fields based on the API's schema or as a raw JSON payload.
- Input (Fields) (required) — Provide input values mapped to the selected API's input schema fields when 'Fields' mode is chosen.
- Input (JSON) (required) — Provide a complete normalized JSON object as input when 'Raw JSON' mode is chosen.
- Return Immediately — If enabled, return a request ID immediately for asynchronous APIs instead of waiting for completion.
- Fields — Comma-separated keys (including support for nested dotted paths) to keep in each result item, trimming the response but not affecting cost.
- Max Items — Limit the number of result items returned; zero means unlimited. This does not change usage cost.
- Summary Only — Return only a structural outline of the data instead of the full content; this does not change cost.
Output shape
a list of JSON objects representing the API response items or, if asynchronous and configured, a request ID object
If the API runs asynchronously and "Return Immediately" is false, the node waits and returns the completed result; if true, it returns a request ID for later retrieval. Options can limit or trim the output. Errors in execution produce node errors unless "Continue On Fail" is enabled.