> ## 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.

# Hook Output • AI Agent SDK

> HookOutput: Base hook output - common fields for all events.

# HookOutput

> Defined in the [**types**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/types.md) module.

AI Agent

Base hook output - common fields for all events.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#8B0000', 'primaryTextColor': '#fff', 'primaryBorderColor': '#710101', 'lineColor': '#189AB4', 'secondaryColor': '#189AB4', 'tertiaryColor': '#fff' }}}%%

graph TD
    event["Event Trigger"] --> hook["Hook: HookOutput"]
    hook --> decision{"Decision"}
    decision -- "Allow" --> proc["Process"]
    decision -- "Deny" --> block["Block"]
    style hook fill:#189AB4,color:#fff
    style event fill:#8B0000,color:#fff
    style proc fill:#8B0000,color:#fff
    style block fill:#8B0000,color:#fff
```

## Properties

**proceed** `bool`

No description available.

**stop\_reason** `Optional[str]`

No description available.

**suppress\_output** `bool`

No description available.

**system\_message** `Optional[str]`

No description available.

**decision** `HookDecision`

No description available.

**reason** `Optional[str]`

No description available.

**modified\_data** `Optional`

No description available.

## Methods

> [card] [is\_blocking()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/HookOutput-is_blocking.md)
>
> Check if this output represents a blocking decision.

> [card] [should\_stop()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/HookOutput-should_stop.md)
>
> Check if execution should stop.

> [card] [get\_reason()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/HookOutput-get_reason.md)
>
> Get the effective reason for blocking or stopping.

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/hooks/types.py#L247)
>
> `praisonaiagents/hooks/types.py` at line 247

***

## Related Documentation

> [card] [Hooks Concept](https://praison.ai/docs/docs/concepts/hooks)

> [card] [Hook Events](https://praison.ai/docs/docs/features/hook-events)

> [card] [Callbacks](https://praison.ai/docs/docs/features/callbacks)

> [card] [Output Concept](https://praison.ai/docs/docs/concepts/output)

> [card] [Output Configuration](https://praison.ai/docs/docs/configuration/output-config)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.