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

# Workspace • AI Agent SDK

> Workspace: Workspace configuration for agent operations.

# Workspace

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

AI Agent

Workspace configuration for agent operations.

Provides path containment and access control for file operations,
ensuring agents can only access files within their designated workspace.

Attributes:
root: Absolute path to workspace directory (must exist, refuses "/")
access: Access mode ("rw" = read-write, "ro" = read-only, "none" = copy-on-write sandbox)
scope: Workspace scope level ("shared", "session", "user", "agent")
session\_key: Optional session identifier for scope resolution

## Properties

**root** `Path`

No description available.

**access** `WorkspaceAccess`

No description available.

**scope** `WorkspaceScope`

No description available.

**session\_key** `Optional[str]`

No description available.

## Methods

> [card] [from\_config()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Workspace-from_config.md)
>
> Create workspace from bot configuration.

> [card] [contains()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Workspace-contains.md)
>
> Check if a path is contained within this workspace.

> [card] [resolve()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Workspace-resolve.md)
>
> Resolve a path against the workspace root with security checks.

> [card] [is\_read\_only()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Workspace-is_read_only.md)
>
> Check if workspace is in read-only mode.

> [card] [is\_sandbox\_mode()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/Workspace-is_sandbox_mode.md)
>
> Check if workspace is in copy-on-write sandbox mode.

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/workspace/__init__.py#L18)
>
> `praisonaiagents/workspace/__init__.py` at line 18


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