Skip to main content
GET
/
cases
/
{id}
/
progress
/
poll
Poll case progress updates (HTTP fallback)
curl --request GET \
  --url https://api.uk.veridox.ai/cases/{id}/progress/poll \
  --header 'x-api-key: <api-key>'
{
  "events": [
    {
      "type": "file.analysis.progress",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": 123,
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stage": "<string>",
      "progress": 123,
      "outcome": "success",
      "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>"
    }
  ],
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.veridox.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
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