> ## Documentation Index
> Fetch the complete documentation index at: https://simplex.sh/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Poll Session Status

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

| Field               | Type            | Description                                                                                                           |
| ------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
| `in_progress`       | boolean         | `true` if the session is still running, `false` when complete                                                         |
| `success`           | boolean \| null | `null` while the session is in progress, `true` if the session completed successfully, `false` if the session failed  |
| `paused`            | boolean         | `true` if the session is currently paused and waiting to be resumed, `false` otherwise                                |
| `paused_key`        | string          | The pause key identifier if the session is paused, empty string otherwise                                             |
| `workflow_metadata` | object \| null  | Metadata set in the workflow definition                                                                               |
| `session_metadata`  | object \| null  | Custom metadata you provided when starting the session                                                                |
| `file_metadata`     | array \| null   | Metadata for files downloaded during the session                                                                      |
| `structured_output` | object \| null  | Structured output fields from workflow execution. `null` while the session is in progress, populated at session close |
| `final_message`     | string \| null  | A summary of what the agent accomplished. `null` while the session is in progress, populated at session close         |

## Example Response (In Progress)

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

## Example Response (Paused)

```json theme={null}
{
  "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,
  "final_message": null
}
```

## Example Response (Completed)

```json theme={null}
{
  "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" },
  "final_message": "Successfully downloaded the report and verified the approval status."
}
```