> This page is for version v8.3.0 (default).
> For other versions, use one of these documentation indexes:
> - v8.3.0 (default): https://docs.workflows.com/v-8-3-0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.workflows.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.workflows.com/_mcp/server.

# get_snapshot_status

GET

# get_snapshot_status

Checks the processing status of a snapshot. Since snapshot creation is asynchronous, poll this tool until the status reaches `completed` before running simulations.

> **Info**
>
> Returns the current processing state, progress percentage, and any error messages if issues occur.

## Parameters

### mindId

<table>
  <tr>
    <td>
      **Type**
    </td>

    <td>
      string
    </td>
  </tr>

  <tr>
    <td>
      **Required**
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      **Description**
    </td>

    <td>
      The mind ID from the 

      `create_mind`

       response
    </td>
  </tr>
</table>

### snapshotId

<table>
  <tr>
    <td>
      **Type**
    </td>

    <td>
      string
    </td>
  </tr>

  <tr>
    <td>
      **Required**
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      **Description**
    </td>

    <td>
      The 

      `mindAssessmentId`

       from the 

      `create_snapshot`

       response
    </td>
  </tr>
</table>

## Request

```json
{
  "mindId": "abc-123-def-456",
  "snapshotId": "snapshot-123-abc-456"
}
```

## Response Examples

#### While Processing

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174003",
  "mindId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "processing",
  "startedAt": "2025-01-15T10:00:00.000Z",
  "completedAt": null
}
```

Training is in progress. Continue polling every 30-60 seconds.

#### Training Finished

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174003",
  "mindId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "startedAt": "2025-01-15T10:00:00.000Z",
  "completedAt": "2025-01-15T10:05:00.000Z"
}
```

Training is complete. Model is ready for simulations using the `simulate` tool.

#### Training Error

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174003",
  "mindId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "failed",
  "startedAt": "2025-01-15T10:00:00.000Z",
  "completedAt": "2025-01-15T10:02:00.000Z"
}
```

Training failed. Check the error message or try uploading more data.

### Response Properties

| Property      | Type           | Description                                                          |
| ------------- | -------------- | -------------------------------------------------------------------- |
| `id`          | string         | Snapshot identifier (matches snapshotId parameter)                   |
| `mindId`      | string         | Associated mind identifier                                           |
| `status`      | string         | Current status: `processing`, `completed`, or `failed`               |
| `startedAt`   | string         | ISO 8601 timestamp when training started                             |
| `completedAt` | string \| null | ISO 8601 timestamp when training finished (null if still processing) |

## Status Reference

#### processing

**Meaning:** AI model is still training on your data

**Next Action:** Continue polling every 30-60 seconds

**Typical Duration:** 5-15 minutes for most files

#### completed

**Meaning:** Training succeeded and model is ready

**Next Action:** Proceed to the `simulate` tool

**Details:** The `completedAt` timestamp indicates when processing finished

#### failed

**Meaning:** Processing encountered an error

**Next Action:** Check the error message and address the issue before retrying

**Common Causes:** Insufficient data, corrupted files, or format issues

## Polling Best Practices

> **Tip**
>
> **Recommended polling strategy:**
>
> 1. First 5 minutes: Poll every 30 seconds
> 2. After 5 minutes: Increase to 60-second intervals
> 3. Maximum timeout: 30 minutes
> 4. On error: Stop polling and check error message
>
> Your AI assistant handles this automatically.

## Error Responses

#### 404 Not Found

```json
{
  "error": "Not Found",
  "message": "Snapshot with ID 'snapshot-123' does not exist"
}
```

**Solution:** Verify the `snapshotId` is correct and ensure you're using the mindAssessmentId from `create_snapshot`.

#### 401 Unauthorized

```json
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}
```

**Solution:** Verify your API key in the MCP server configuration and ensure the format is correct: `Bearer YOUR_KEY`.

## Next Steps

#### Run Simulations

[simulate](/mcp-tool-simulate) - Generate predictions using the trained model

## See Also

#### [create_snapshot](/mcp-tool-create-snapshot)

Previous step: Start training

#### [simulate](/mcp-tool-simulate)

Next step: Run simulations