Storm OpenAPI(en)
  1. Document
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
        POST
      • Document Training Request by URL
        POST
      • View Documents
        GET
      • Delete Document
        DELETE
    • 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. Document

Document Training Request by URL

POST
/api/v2/documents/by-url
It generally takes about 10 seconds to 1 minute per document, and may take longer when parserType=STORM_PARSE.
This API responds when the document learning “request” is completed. To receive the result at the time of actual learning “completion”, please specify the webhookUrl parameter.
Files in Google Drive must be accessible to anyone with the link.

Request

Authorization
Add parameter in header
storm-api-key
Example:
storm-api-key: ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v2/documents/by-url' \
--header 'storm-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bucketId": "string",
    "url": "string",
    "parserType": "DEFAULT",
    "webhookUrl": "string"
}'
Response Response Example
{
    "status": "success",
    "data": {
        "id": "7336209765206708224",
        "parserType": "STORM_PARSE",
        "dorigin": "google",
        "dtype": "pdf",
        "name": "v8.pdf",
        "description": null,
        "source": "https://drive.google.com/file/d/testfiletestfile/view?usp=sharing",
        "status": "progress",
        "characters": null,
        "createdAt": "2025-06-05T01:58:28.211Z",
        "updatedAt": "2025-06-05T01:58:28.211Z",
        "bucketName": "test_agent",
        "creatorName": "외부테스트계정",
        "lastEditorName": "외부테스트계정"
    }
}
Modified at 2025-06-05 03:57:33
Previous
Document Training Request by file
Next
View Documents
Built with