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

# snapshot • AI Agent SDK

> snapshot: Return a small, JSON-serialisable forensic context.

# snapshot

<div className="flex items-center gap-2">
  <Badge color="purple">Method</Badge>
</div>

> This is a method of the [**ShutdownForensicsProtocol**](../classes/ShutdownForensicsProtocol) class in the [**protocols**](../modules/protocols) module.

Return a small, JSON-serialisable forensic context.

Must never raise; on any internal failure it returns a best-effort
(possibly partial) dict so the caller can still log *something*.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def snapshot(signal_name: Optional[str]) -> Dict[str, Any]
```

## Parameters

<ParamField query="signal_name" type="Optional[str]" required={false}>
  No description available.
</ParamField>

### Returns

<ResponseField name="Returns" type="Dict[str, Any]">
  The result of the operation.
</ResponseField>

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L4135">
  `praisonaiagents/gateway/protocols.py` at line 4135
</Card>