Storm OpenAPI(en)
  1. Node Description
Storm OpenAPI(en)
  • Welcome to STORM
    • Introduction
  • Quickstart
    • Getting Started
      • Creating an Agent
      • Account Creation
    • Core Scenario
      • Document Upload
      • Workflow Design
      • Test
      • Deployment
      • Channel Integration
  • Feature Guide
    • Console
      • Agent Management
      • Dashboard
      • Permission Management
    • Agent Template
      • Knowledge Retrieval
      • Character Dialogue
      • Consultation Record Analysis
      • SQL Query
      • News Article
    • Agent Builder
      • Knowledge
        • Documents
        • Folders
        • Feedback
      • Workflow
        • Node Description
          • LLM
          • Search(RAG)
          • API
          • IF ELSE
          • Variable Declaration and Assignment
          • Postprocessing
      • Test
      • Log
      • Dashboard
    • Admin Tools
      • Deployment Management
      • Channel Integration
      • Model Fine-Tuning
      • Training Data Quality Management
      • Other Settings
  • Apis
    • Agent
      • Deploy Agent
      • View Agent Deployment History
      • View Agent
    • Bucket
      • Create Bucket
      • View Bucket
    • Document
      • Document Training Request by file
      • Document Training Request by URL
      • View Documents
      • Delete Document
    • Chat
      • Send Chat (non-stream)
      • Send Chat (stream)
      • Search Context
    • STORM Parse
      • /convert/md
    • Instance Agent
      • Add Instance Session
      • Upload Instance Document
      • Request RAG Source For Query
      • Delete Instance Session
  • Learn More
    • FAQ
    • Pricing
  1. Node Description

API

API Node#

The API Node is used to call external APIs to retrieve data or integrate with external systems. It includes configuration for both requests and responses.

API#

Group 633059 1.png
Specify the endpoint URL and HTTP method (GET, POST, PUT, DELETE, etc.) to define the type of request.
Each method serves a different purpose:
GET: Retrieve data from the server
POST: Send data to create new records
PUT: Update existing records
DELETE: Remove records

Body#

Group 633059 2.png
Enter the data to be sent to the server in JSON format.
Commonly used in POST or PUT requests to send structured data.
Example:
{
  "userId": 101,
  "query": "customer data"
}

Header#

Group 633059 3.png
Define the HTTP headers to include in your request.
Headers can carry metadata such as authentication credentials, content type, or custom parameters.
Example:
Content-Type: application/json
Authorization: Bearer <token>

Authorization#

Group 633059 4.png
Set the authentication method for API access.
Supported methods:
Basic Auth — Uses a username and password encoded in Base64.
Bearer Token — Uses a token (such as a JWT) for secure access.

Timeout#

Group 633059 5.png
Set the maximum waiting time for the API response.
If the response is not received within this time, the request will automatically fail.
Adjust the timeout according to API reliability and network latency.
Modified at 2025-10-20 05:50:14
Previous
Search(RAG)
Next
IF ELSE
Built with