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

View Documents

Developing
GET
/api/v2/documents

Request

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

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v2/documents?agentId&bucketId&documentId&page&size' \
--header 'storm-api-key: <api-key>'
Response Response Example
{
    "status": "success",
    "data": {
        "data": [
            {
                "id": "1",
                "status": "success",
                "name": "문서1",
                "dorigin": "quis cupidatat in",
                "dtype": "FILE",
                "description": null,
                "source": null,
                "characters": null,
                "createdAt": "2024-11-21T17:09:56.325Z",
                "updatedAt": "2025-08-08",
                "bucket": {
                    "id": "1",
                    "name": "버킷1",
                    "type": "default",
                    "createdAt": "2024-11-21T18:24:16.258Z",
                    "updatedAt": "2024-11-21T18:24:16.258Z"
                }
            }
        ],
        "pageInfo": {
            "page": 33141626,
            "size": 81987804,
            "totalElements": 55405296,
            "totalPages": -32768572
        }
    }
}
Modified at 2025-05-30 06:06:29
Previous
Document Training Request by URL
Next
Delete Document
Built with