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, false when complete
successboolean | nullnull while the session is in progress, true if the session completed successfully, false if the session failed
pausedbooleantrue if the session is currently paused and waiting to be resumed, false otherwise
paused_keystringThe pause key identifier if the session is paused, empty string otherwise
workflow_metadataobject | nullMetadata set in the workflow definition
session_metadataobject | nullCustom metadata you provided when starting the session
file_metadataarray | nullMetadata for files downloaded during the session
structured_outputobject | nullStructured output fields from workflow execution. null while the session is in progress, populated at session close

​
Example Response (In Progress)

{
  "in_progress": true,
  "success": null,
  "paused": false,
  "paused_key": "",
  "workflow_metadata": { "version": "1.0" },
  "session_metadata": { "user_id": "123" },
  "file_metadata": [],
  "structured_output": null
}

​
Example Response (Paused)

{
  "in_progress": true,
  "success": null,
  "paused": true,
  "paused_key": "user_pause",
  "workflow_metadata": { "version": "1.0" },
  "session_metadata": { "user_id": "123" },
  "file_metadata": [],
  "structured_output": null
}

​
Example Response (Completed)

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