For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Agent Builder
    • Using the Agent Builder
  • Prompts
    • Prompt Engineering
    • Collaboration
    • Custom Models
    • Multimodality
    • Prompt Caching
  • Workflows
    • Introduction
    • Experimenting
      • Overview
      • Agent Node
      • Prompt Node
      • Prompt Deployment Node
      • Templating Node
      • Search Node
      • API Node
      • Code Execution Node
      • Subworkflow Node
      • Map Node
      • Guardrail Node
      • Conditional Node
      • Merge Node
      • Final Output Node
      • Error Node
      • Note Node
      • Node Adornments
    • Integrating
    • Function Calling
  • Evaluation & Test Suites
    • Quantitative Evaluation
    • Evaluating RAG Pipelines
    • Online Evaluations
  • Metrics
    • Out of the Box Metrics
    • Custom Metrics
    • Reusing Metrics in Test Suites
  • Deployments
    • Deployment Lifecycle Management
    • Observability in Production
    • Environments
    • Release Tags
    • Release Reviews
  • Monitoring
    • Monitoring Production Trends
    • Track Workflow Execution Costs
    • Datadog Integration
    • Webhook Integration
    • Execution URLs
  • Documents
    • Uploading Documents
    • Integrating w/ Search API
    • Metadata Filtering
  • Security
    • Data Privacy and Storage
    • HMAC Authentication
    • Role-Based Access Control (RBAC)
    • Static IPs
  • Organizations
    • Manage Organization Access
    • Data Retention Policies
LogoLogo
BlogLog InRequest Demo
On this page
  • API Node Interface
  • Key Features
WorkflowsNodes

API Node

Was this page helpful?
Previous

Code Execution Node

Next
Built with

The API Node invokes an API endpoint and returns back the status code, raw output, and JSON output if applicable. These APIs can be either publicly accessible or privately defined within your backend through the help of Authorization headers and Secrets.

API Node Interface

The API Node provides a simple interface for configuring your API requests:

API Node

When you open the API Node, you’ll see a detailed configuration interface where you can define your request:

API Node Configuration

Key Features

  • HTTP Methods: Support for standard methods (GET, POST, PUT, DELETE, etc.)
  • Request Body: Configure JSON or form data payloads
  • Authorization: Multiple auth types including None, Bearer Token, and API Key
  • Headers: Add custom headers to your requests
  • Dynamic URLs: Create flexible API calls using variables
  • Timeout Configuration: Set maximum request duration to prevent workflows from hanging on slow or unresponsive external services
Tip: Creating Dynamic URLs

You can use a Templating Node and the “Dynamic” field of an API Node to quickly and flexibly make API calls in your Workflows. See the example below for more details. Notice how we do string concatenation in the Templating Node using Jinja2’s ~ syntax.

Dynamic URL Example Workflow