Get upload session status

curl --request GET \
  --url http://localhost/v1/documents/upload/{sessionId}/status \
  --header 'X-API-Key: <api-key>'

{
  "sessionId": "<string>",
  "status": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "files": [
    {
      "fileId": "<string>",
      "fileName": "<string>",
      "receivedChunks": [
        123
      ],
      "totalChunks": 123
    }
  ]
}

Documents

Get upload session status

Get the current status of a chunked upload session.

Returns overall session status plus per-file chunk progress.

Session status values:

Uploading - Chunks are still being received
Processing - All chunks received; compliance analysis in progress
Completed - Document processing finished successfully
Failed - An error occurred during processing

Per-file progress: Each file entry includes receivedChunks (list of received chunk indexes) and totalChunks. Compare lengths to calculate upload percentage per file.

Poll interval: Check every 5–10 seconds during active upload.

GET

documents

upload

{sessionId}

status

Get upload session status

curl --request GET \
  --url http://localhost/v1/documents/upload/{sessionId}/status \
  --header 'X-API-Key: <api-key>'

{
  "sessionId": "<string>",
  "status": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "files": [
    {
      "fileId": "<string>",
      "fileName": "<string>",
      "receivedChunks": [
        123
      ],
      "totalChunks": 123
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API Key provided by Eve Admin Portal. Include this header in all authenticated requests.

Path Parameters

sessionId

string

required

Response

sessionId

string

status

string

expiresAt

string<date-time>

files

object[]

Show child attributes

Upload a file chunk Start a chunked upload session