Skip to content
Qualia Docs

Advisory in-flight upload heartbeat for the pending band

POST
/v1/datasets/upload/heartbeat
 
curl --request POST \
  --url https://example.com/v1/datasets/upload/heartbeat \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "repo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sequence": 1, "total_files": 0, "total_bytes": 0, "transferred_bytes": 0, "uploaded_bytes": 0, "staged_files": 0, "done": false, "failed": false, "failure_reason": "" }'

Makes the chunk-transfer phase visible in /datasets/uploads — the only upload phase no QDS artifact can see. Advisory: a miss costs a pending-band entry, never an upload, so the SDK calls this best-effort.

The answer says whether the user has cancelled the upload (QUA-3009); a client that reads cancelled: true stops. (This route answered 204 with no body before, and an SDK of that era never reads one.)

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
UploadHeartbeatBody
object
repo_id
required
string format: uuid
session_id
required
string format: uuid
sequence
required
integer
>= 1
total_files
integer
0
total_bytes
integer
0
transferred_bytes
integer
0
uploaded_bytes
integer
0
staged_files
integer
0
done
boolean
failed
boolean
failure_reason
string
"" <= 500 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UploadHeartbeatResponse
object
cancelled
boolean
Example 
{
  "cancelled": false
}

401

Section titled “401 ”

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}