Skip to main content
GET
Poll case progress updates (HTTP fallback)
Retrieve case analysis progress events via incremental polling. This endpoint also serves as a fallback when Server-Sent Events (SSE) streaming is not available. It returns only the newest events since the specified last_event_id, making it efficient for periodic polling.

Permission

You can follow a case you created, or any case in your organisation if you have organisation_cases:read; otherwise the API returns 404. Per-file events cover only the files you uploaded, and those uploaded through document requests into a case you created, unless you have organisation_files:read. Shared cases, if enabled for your organisation, also give you reach to every case and file. See Permissions and API Keys.

When to Use Polling vs Streaming

Use Streaming (SSE) When:

  • Real-time updates are critical.
  • Low-latency progress monitoring is needed.
  • Network supports persistent connections.

Use Polling When:

  • SSE streaming fails or is blocked by network restrictions.
  • Simple periodic updates are sufficient.
  • Low-latency is not a requirement.

Best Practices

  1. Incremental Polling: Always use last_event_id to avoid receiving duplicate events and reduce response size.
  2. Polling Intervals: Use 2-5 second intervals to balance responsive updates with server load.
  3. Timeout Handling: Implement reasonable timeouts (e.g., 10-15 minutes) for long-running analyses.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Case ID

Response

List of progress events retrieved successfully

events
object[]
required
has_more
boolean
required