Storm OpenAPI(en)
  1. Instance Agent
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
        POST
      • Upload Instance Document
        POST
      • Request RAG Source For Query
        POST
      • Delete Instance Session
        POST
  • Learn More
    • FAQ
    • Pricing
  1. Instance Agent

Add Instance Session

Developing
POST
/api/guest/session
Creates a session that assigns the guest ID to a Specific RAG Component.

Request

Authorization
Add parameter in header
storm-api-key
Example:
storm-api-key: ********************
Header Params

Body Params application/json

Examples

Responses

🟒200Success
application/json
Body

🟠400GUEST_ID_REQUIRED
🟠401ACTIVE_SESSION_ALREADY_EXISTS
🟠409ACTIVE_SESSION_NOT_FOUND
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/guest/session' \
--header 'x-storm-guest-id: 4a4f3d33-9c6f-41b9-bc78-43c3cb462f42' \
--header 'storm-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
200 - Example 1
{
    "status": "success",
    "data": {
        "id": "string",
        "createdAt": "string",
        "props": {
            "guestId": "string",
            "agentId": "string",
            "bucketId": "string",
            "isActive": true
        }
    }
}
Modified atΒ 2025-06-11 01:22:31
Previous
/convert/md
Next
Upload Instance Document
Built with