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

# hydration

# `prefect.utilities.schema_tools.hydration`

## Functions

### `handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L172](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L172)</sup>

```python theme={null}
handler(kind: PrefectKind) -> Callable[[Handler], Handler]
```

### `call_handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L180](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L180)</sup>

```python theme={null}
call_handler(kind: PrefectKind, obj: dict[str, Any], ctx: HydrationContext) -> Any
```

### `null_handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L191](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L191)</sup>

```python theme={null}
null_handler(obj: dict[str, Any], ctx: HydrationContext)
```

### `json_handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L200](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L200)</sup>

```python theme={null}
json_handler(obj: dict[str, Any], ctx: HydrationContext)
```

### `jinja_handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L229](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L229)</sup>

```python theme={null}
jinja_handler(obj: dict[str, Any], ctx: HydrationContext) -> Any
```

### `workspace_variable_handler` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L264](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L264)</sup>

```python theme={null}
workspace_variable_handler(obj: dict[str, Any], ctx: HydrationContext) -> Any
```

### `hydrate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L294](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L294)</sup>

```python theme={null}
hydrate(obj: dict[str, Any], ctx: Optional[HydrationContext] = None) -> dict[str, Any]
```

## Classes

### `HydrationContext` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L14](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L14)</sup>

**Methods:**

#### `build` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L25](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L25)</sup>

```python theme={null}
build(cls, session: AsyncSession, raise_on_error: bool = False, render_jinja: bool = False, render_workspace_variables: bool = False) -> Self
```

### `Placeholder` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L59](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L59)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L64](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L64)</sup>

```python theme={null}
is_error(self) -> bool
```

### `RemoveValue` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L68](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L68)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L64](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L64)</sup>

```python theme={null}
is_error(self) -> bool
```

### `HydrationError` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L76](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L76)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L81](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L81)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L64](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L64)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L86](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L86)</sup>

```python theme={null}
message(self) -> str
```

### `KeyNotFound` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L96](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L96)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L81](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L81)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L103](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L103)</sup>

```python theme={null}
key(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L98)</sup>

```python theme={null}
message(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L86](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L86)</sup>

```python theme={null}
message(self) -> str
```

### `ValueNotFound` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L107](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L107)</sup>

**Methods:**

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L109](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L109)</sup>

```python theme={null}
key(self) -> str
```

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L103](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L103)</sup>

```python theme={null}
key(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L98)</sup>

```python theme={null}
message(self) -> str
```

### `TemplateNotFound` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L113](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L113)</sup>

**Methods:**

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L115](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L115)</sup>

```python theme={null}
key(self) -> str
```

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L103](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L103)</sup>

```python theme={null}
key(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L98)</sup>

```python theme={null}
message(self) -> str
```

### `VariableNameNotFound` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L119](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L119)</sup>

**Methods:**

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L121](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L121)</sup>

```python theme={null}
key(self) -> str
```

#### `key` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L103](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L103)</sup>

```python theme={null}
key(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L98)</sup>

```python theme={null}
message(self) -> str
```

### `InvalidJSON` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L125](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L125)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L81](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L81)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L127](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L127)</sup>

```python theme={null}
message(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L86](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L86)</sup>

```python theme={null}
message(self) -> str
```

### `InvalidJinja` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L134](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L134)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L81](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L81)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L136](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L136)</sup>

```python theme={null}
message(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L86](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L86)</sup>

```python theme={null}
message(self) -> str
```

### `WorkspaceVariableNotFound` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L143](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L143)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L81](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L81)</sup>

```python theme={null}
is_error(self) -> bool
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L150](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L150)</sup>

```python theme={null}
message(self) -> str
```

#### `message` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L86](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L86)</sup>

```python theme={null}
message(self) -> str
```

#### `variable_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L145](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L145)</sup>

```python theme={null}
variable_name(self) -> str
```

### `WorkspaceVariable` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L154](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L154)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L64](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L64)</sup>

```python theme={null}
is_error(self) -> bool
```

### `ValidJinja` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L164](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L164)</sup>

**Methods:**

#### `is_error` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema\_tools/hydration.py#L64](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/hydration.py#L64)</sup>

```python theme={null}
is_error(self) -> bool
```