Call an API

Overview#

Make HTTP requests with explicit host and credential controls.

Use this block when its responsibility is clear in the graph. Give it a name that describes the work it performs, then test it with representative input before publishing.

Working examples#

These are complete starting points, not decorative diagrams. Every graph is also available in the main template library and is checked by the workflow compiler.

1. Read a public JSON API#

You will build: A parsed response from an allowlisted host.

Connects live public data to a workflow. GET requests are retry-safe; keep the host allowlist narrow.

Open this template and adapt the labels, prompts, or credentials to your own workflow.

2. Create an idempotent webhook event#

You will build: One externally visible event per workflow run.

Supports controlled write integrations. A stable idempotency key prevents duplicate writes during retries.

Open this template and adapt the labels, prompts, or credentials to your own workflow.

3. Check service health#

You will build: Current service status payload.

Makes an upstream dependency check visible. A short timeout prevents the workflow from waiting indefinitely.

Open this template and adapt the labels, prompts, or credentials to your own workflow.

Ports#

• Input: Request (in): any, optional, single.
• Output: Success (success): object, optional, single.
• Output: Error (error): object, optional, single.

Inspector#

• URL: key url; text; default: ""; Example: https://api.example.com/endpoint.
• Method: key method; select; options: GET, POST, PUT, PATCH, DELETE; default: "GET".
• Credentials: key credentialMode; select; options: none, runner, creator_shared; default: "none".
• Allowed Hosts (comma-separated): key allowOnly; text; default: [].
• Denied Hosts (comma-separated): key denyHosts; text; default: ["127.0.0.1","localhost","0.0.0.0"].
• Require idempotency (POST/PUT/PATCH): key hasSideEffects; switch; default: false.
• Idempotency key: key idempotencyKey; text.
• Timeout (ms): key timeout; number; range: 1000 to 120000; default: 30000.
• Follow Redirects: key followRedirects; inline switch; default: true.
• http-request editor: manages headers, query, body, credentialRequirements with edit, validate, preview support.

Behavior#

• Input requirement: Provide one of ports in or config fields url.
• Execution: Handled by the handler using http-request.
• Timeout: 30000 ms by default (1000 to 120000 ms).

Cost#

Uses outbound HTTP transport and may contribute to the run's compute cost.

Security#

• Credentials may be runner-provided or creator-shared according to the node configuration. Network destination policy is enforced at runtime.
• The configured operation may write externally. Mutating requests require explicit idempotency configuration for safe retries.

Retry#

Automatic retries are allowed only when the operation is retry-safe; mutating requests require a stable run-scoped idempotency key.

Production checklist#

• Test the happy path and one malformed or empty input.
• Keep credentials out of prompts and published graph configuration.
• Set a timeout and retry policy that matches the operation's side effects.
• Name the final result so a runner can tell what success looks like.