Document Training Request by file

POST

/api/v2/documents/by-file

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.

Request

Authorization

Add parameter in header

storm-api-key

Example:

storm-api-key: ********************

Body Params multipart/form-data

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v2/documents/by-file' \
--header 'storm-api-key: <api-key>' \
--form 'bucketId=""' \
--form 'file=@""' \
--form 'parserType=""' \
--form 'webhookUrl=""' \
--form 'fileName=""'

Response Example

{
    "status": "success",
    "data": {
        "id": "7336212821593927680",
        "parserType": "STORM_PARSE",
        "dorigin": "file",
        "dtype": "pdf",
        "name": "v15.pdf",
        "description": null,
        "source": null,
        "status": "progress",
        "characters": null,
        "createdAt": "2025-06-05T02:10:36.911Z",
        "updatedAt": "2025-06-05T02:10:36.911Z",
        "bucketName": "test_agent",
        "creatorName": "외부테스트계정",
        "lastEditorName": "외부테스트계정"
    }
}

Modified at 2025-06-05 06:34:10

View Bucket

Document Training Request by URL