Stream case progress updates (SSE)
Cases
Stream Case Analysis Progress
Receive real-time Server-Sent Events for case analysis progress updates.
GET
Stream case progress updates (SSE)
Establish a Server-Sent Events (SSE) connection to receive real-time progress updates during case analysis. This endpoint provides live streaming of analysis events including file processing stages, progress percentages, and completion notifications.
Event Types
The stream provides several event types to help you track progress:file.analysis.progress: Real-time updates on individual file processing stages.file.analysis.completed: Notification that a specific file has finished analysis.case.analysis.completed: Final event indicating the entire case is complete.heartbeat: Connection keep-alive signal.stream_closed: Indicates the stream has ended (e.g., if analysis was already finished).
Best Practices
- Reconnection Logic: Implement automatic reconnection with exponential backoff to handle transient network issues.
- Fallback Mechanism: Always detect SSE connection failures and automatically switch to polling.
- Resource Cleanup: Ensure connections are closed when the user leaves the progress screen or the analysis completes.
Authorizations
Path Parameters
Case ID
Query Parameters
API key for authentication (alternative to access_token)
Access token for JWT authentication
Response
Unauthorized (invalid or missing authentication token)
Machine-readable error code for programmatic handling
Examples:
"request.cases.file.missing-risk-score"
"request.authentication.invalid-token"
"request.forbidden"
"request.cases.case.not-found"
"request.cases.case.already-locked"
Human-readable error message explaining what went wrong
Example:
"User tried to perform an invalid operation on a file without a risk score."
Example: