Skip to main content
GET
Follow or resume a document's events (SSE). See the events guide.

Authorizations

Authorization
string
header
required

Authorization: Bearer ak_eu_…. The prefix is the project's region and must match the server (api.eu / api.us).

Headers

Last-Event-ID
string

Resume after this sequence.

Path Parameters

document_id
string
required

Query Parameters

after
integer
Required range: 0 <= x <= 9007199254740991

Response

text/event-stream; each data: is a DocumentEvent.

id
string
required

Unique; dedupe webhooks by it.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
type
string
required
Examples:

"content.block_completed"

"document.ready"

version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
document_id
string
required
Pattern: ^doc_[0-9A-HJKMNP-TV-Z]{26}$
sequence
integer
required

1, 2, 3… per document. It is the SSE id:.

Required range: 1 <= x <= 9007199254740991
timestamp
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
data
object
required
display
object

Short UI text per language, e.g. { es: 'Revisando…' }.