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

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

Last-Event-ID
string

Resume after this sequence.

Parámetros de ruta

document_id
string
requerido

Parámetros de consulta

after
integer
Rango requerido: 0 <= x <= 9007199254740991

Respuesta

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

id
string
requerido

Unique; dedupe webhooks by it.

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

"content.block_completed"

"document.ready"

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

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

Rango requerido: 1 <= x <= 9007199254740991
timestamp
string<date-time>
requerido
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
requerido
display
object

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