Skip to main content
Poll the status of a running or completed session. This endpoint allows you to monitor session progress and retrieve results without using webhooks.

​
Response Fields

FieldTypeDescription
in_progressbooleantrue if the session is still running (Running or Shutting down status), false if the session has reached a terminal state (Completed, Failed, Stopped, or Timed out)
successboolean | nullnull while the session is in progress, true if the session completed successfully, false if the session failed or timed out
metadataobject | nullCustom metadata provided when the session was started
workflow_metadataobject | nullMetadata from the workflow definition (if running a workflow)
file_metadataarray | nullMetadata for files downloaded during the session

​
Example Response (In Progress)

{
  "in_progress": true,
  "success": null,
  "metadata": { "user_id": "123" },
  "workflow_metadata": { "version": "1.0" },
  "file_metadata": []
}

​
Example Response (Completed)

{
  "in_progress": false,
  "success": true,
  "metadata": { "user_id": "123" },
  "workflow_metadata": { "version": "1.0" },
  "file_metadata": [
    {
      "filename": "report.pdf",
      "download_url": "https://example.com/report.pdf",
      "file_size": 102400,
      "download_timestamp": "2024-01-15T10:30:00Z",
      "session_id": "abc123"
    }
  ]
}