# GoalSnapshot

> **Class** in `deepagents_code`

📖 [View in docs](https://reference.langchain.com/python/deepagents-code/goal_tools/GoalSnapshot)

Read-only goal view returned by the `get_goal` tool to the model.

A fixed-shape projection of goal state. Both construction branches in
`_goal_snapshot` must populate every key, so the type checker catches a
drift between them.

## Signature

```python
GoalSnapshot()
```

## Extends

- `TypedDict`

## Constructors

```python
__init__(
    active: bool,
    objective: str | None,
    status: GoalStatus | None,
    criteria: str | None,
    note: str | None,
)
```

| Name | Type |
|------|------|
| `active` | `bool` |
| `objective` | `str \| None` |
| `status` | `GoalStatus \| None` |
| `criteria` | `str \| None` |
| `note` | `str \| None` |


## Properties

- `active`
- `objective`
- `status`
- `criteria`
- `note`

---

[View source on GitHub](https://github.com/langchain-ai/deepagents/blob/e14e0adcbe78565ed3650e7f24b2a775d5437d25/libs/code/deepagents_code/goal_tools.py#L88)