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

Upload Instance Document

Developing
POST
/api/guest/documents
Uploads a document to the pylon assigned to the guest ID.

Request

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

Body Params multipart/form-data

Responses

🟢200Success
application/json
Body

🟠400GUEST_ID_REQUIRED
🟠401ACTIVE_SESSION_ALREADY_EXISTS
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/guest/documents' \
--header 'x-storm-guest-id: 4a4f3d33-9c6f-41b9-bc78-43c3cb462f42' \
--header 'storm-api-key: <api-key>' \
--form 'webhookUrl=""' \
--form 'files=@""' \
--form 'urls="https://my-bucket.s3.us-west-2.amazonaws.com/images/pic.jpg?AWSAccessKeyId=AKIAEXAMPLE&Signature=Y%2FzF%2F4z%2BzPpzU%2BeiDqFiq5EXAMPLE%2B8YlmqZnce2kD7K3AZmMl04tvjY5k2yz4N2XJ8F40r5lPjN2g0c8%2FJwv%2Fh3r3Vq0ikgtl93n7M%3D&Expires=1673995872"'
Response Response Example
200 - Example 1
{}
Modified at 2025-05-30 06:25:12
Previous
Add Instance Session
Next
Request RAG Source For Query
Built with