API Node

The API Node allows your pipeline to interact with external APIs by sending HTTP requests. Use an API node when you want to retrieve, send, or update data from an external service during pipeline execution.

Node Inputs

• Method: HTTP method for the request.

  • Type: Dropdown

  • Options: GET, POST, PUT, DELETE, PATCH

• URL: The endpoint to send the request to.

  • Type: Text

• Headers: Key-value pairs for HTTP headers.

  • Type: Table

  • Columns: Key (Text), Value (Text)

  • Example: status: active

• Query Parameters: Key-value pairs for query parameters.

  • Type: Table

  • Columns: Key (Text), Value (Text)

  • Example: status: active

• Body Parameters: Key-value pairs for the request body (used with POST, PUT, etc.).

  • Type: Table

  • Columns: Key (Text), Value (Text)

  • Example: name: John Doe

• Content-Type: The content type for the request body.

  • Type: Radio Buttons

  • Options:

    • Default: Standard form data.

    • Raw JSON: Sends data as application/json.

Node Outputs

• Output: The data received from the API call.

  • Type: Text

  • Example Usage: {{api_0.output}}

Considerations

• Error Handling: If the API call fails, the node can handle errors gracefully and pass error details downstream.

• Raw JSON Body: If selected, the request body will be sent as raw JSON with Content-Type: application/json.

• Default Headers: Automatically includes a Content-Type: application/json header for raw JSON requests if no such header is set manually.

• Data Validation: Ensure that all required fields (e.g., URL and method) are populated before executing the node.