Skip to main content
POST
Seal a record set

Authorizations

X-API-Key
string
header
required

Path Parameters

record_set_id
string
required

Body

application/json

Finalise a record set once every chunk has been sent.

expected_count is the total number of records you sent across all chunks. The API compares it with the number it actually staged and refuses the seal if they disagree, which is how a chunk that was silently lost in transit is caught before anything is dialled. You do not need to know the total in advance — only at seal time — so several files can be streamed into one record set.

Sealing is safe to retry: re-sealing an already-sealed record set with the same expected_count returns the same result.

expected_count
integer
required

Total number of records sent across every chunk.

Required range: x >= 0

Response

Successful Response

A record set's manifest and current progress.

status moves open -> sealed -> consumed: open accepts chunks, sealed is complete and ready to trigger, and consumed means a trigger has claimed it (each record set is used exactly once). received_count and chunk_count track what has arrived so far, content_hash identifies the sealed contents, batch_id points at the batch that consumed it, and staging_expires_at is when an untriggered record set and its staged records are reclaimed.

id
string
required
status
string
required
chunk_size
integer
required
received_count
integer
required
chunk_count
integer
required
expected_count
integer | null
required
content_hash
string | null
required
batch_id
string | null
required
metadata
Metadata · object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
sealed_at
string<date-time> | null
required
consumed_at
string<date-time> | null
required
staging_expires_at
string<date-time>
required