> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Session

> A Composio session — the object returned by `composio.create(...)` / `composio.use(...)`. Use it to fetch session-scoped tools, authorize toolkits,...

## Properties

| Name | Type | |
| - | - | - |
| `session_id` | `str` | |
| `config` | `ToolRouterSessionConfig` | |
| `experimental` | `'ToolRouterSessionExperimental'` | |
| `config_version` | \`int | None\` |
| `preload` | `Any` | |

## Methods

### tools()

Get provider-wrapped tools for execution with your AI framework.  Returns tools configured for this session, wrapped in the format expected by your AI provider (OpenAI, Anthropic, LangChain, etc.).  When custom tools are bound to the session, execution of COMPOSIO\_MULTI\_EXECUTE\_TOOL is intercepted: local tools are executed in-process, remote tools are sent to the backend.

```python theme={null}
def tools(modifiers: 'Modifiers' | None = ...) -> TToolCollection
```

**Parameters**

| Name | Type |
| - | - |
| `modifiers?` | `'Modifiers' \| None` |

**Returns**

`TToolCollection`

***

### authorize()

Authorize a toolkit for the user and get a connection request.  Initiates the OAuth flow and returns a ConnectionRequest with redirect URL.

```python theme={null}
def authorize(toolkit: str, callback_url: str | None = ..., alias: str | None = ..., experimental: session_link_params.Experimental | None = ...) -> ConnectionRequest
```

**Parameters**

| Name | Type |
| - | - |
| `toolkit` | `str` |
| `callback_url?` | `str \| None` |
| `alias?` | `str \| None` |
| `experimental?` | `session_link_params.Experimental \| None` |

**Returns**

`ConnectionRequest`

***

### toolkits()

Get toolkit connection states for the session.

```python theme={null}
def toolkits(toolkits: List[str | None] = ..., next_cursor: str | None = ..., limit: int | None = ..., is_connected: bool | None = ..., search: str | None = ...) -> ToolkitConnectionsDetails
```

**Parameters**

| Name | Type |
| - | - |
| `toolkits?` | `List[str \| None]` |
| `next_cursor?` | `str \| None` |
| `limit?` | `int \| None` |
| `is_connected?` | `bool \| None` |
| `search?` | `str \| None` |

**Returns**

`ToolkitConnectionsDetails`

***

### search()

Search for tools by semantic use case.  Returns relevant tools for the given query with schemas and guidance.

```python theme={null}
def search(query: str, model: str | None = ...) -> ToolRouterSessionSearchResponse
```

**Parameters**

| Name | Type |
| - | - |
| `query` | `str` |
| `model?` | `str \| None` |

**Returns**

`ToolRouterSessionSearchResponse`

***

### execute()

Execute a tool within the session.  For custom tools, accepts the full slug (e.g. "LOCAL\_GREP") or the original slug (e.g. "GREP") when that original slug is unique across the session's custom tools and toolkits. Custom tools are executed in-process; remote tools are sent to the Composio backend.

```python theme={null}
def execute(tool_slug: str, arguments: Dict[str, Any | None] = ..., account: str | None = ..., input_responses: Dict[str, ToolRouterInputResponse | None] = ..., request_state: str | None = ...) -> ToolRouterSessionExecuteResponse
```

**Parameters**

| Name | Type |
| - | - |
| `tool_slug` | `str` |
| `arguments?` | `Dict[str, Any \| None]` |
| `account?` | `str \| None` |
| `input_responses?` | `Dict[str, ToolRouterInputResponse \| None]` |
| `request_state?` | `str \| None` |

**Returns**

`ToolRouterSessionExecuteResponse`

**Raises**

* `ToolInputRequiredError` — If the tool needs input from the user (for example an approval) before it can run. Nothing was executed.
* `ValidationError` — If the API response carries no `result_type`, or one this SDK does not know.

***

### execute\_meta()

Execute a Composio meta tool (`COMPOSIO_*`) within the session.  `execute` also runs meta tools. This method only accepts meta tool slugs, so a typo is a type error instead of a failed request. The call is sent to the Composio backend as is: custom tools named in a `COMPOSIO_MULTI_EXECUTE_TOOL` call are not run in-process here.

```python theme={null}
def execute_meta(slug: ToolRouterSessionMetaToolSlug, arguments: Dict[str, Any | None] = ..., input_responses: Dict[str, ToolRouterInputResponse | None] = ..., request_state: str | None = ...) -> ToolRouterSessionExecuteResponse
```

**Parameters**

| Name | Type |
| - | - |
| `slug` | `ToolRouterSessionMetaToolSlug` |
| `arguments?` | `Dict[str, Any \| None]` |
| `input_responses?` | `Dict[str, ToolRouterInputResponse \| None]` |
| `request_state?` | `str \| None` |

**Returns**

`ToolRouterSessionExecuteResponse` — The tool execution result, in the same shape as `execute`.

**Raises**

* `ToolInputRequiredError` — If the tool needs input from the user (for example an approval) before it can run. Nothing was executed.
* `ValidationError` — If the API response carries no `result_type`, or one this SDK does not know.

**Example**

```python theme={null}
result = session.execute_meta(
    "COMPOSIO_SEARCH_TOOLS",
    arguments={"queries": [{"use_case": "send an email"}]},
)
print(result.result_type, result.data)
```

***

### custom\_tools()

List all custom tools registered in this session.  Returns tools with their final slugs, schemas, and resolved toolkit.

```python theme={null}
def custom_tools(toolkit: str | None = ...) -> List[RegisteredCustomTool]
```

**Parameters**

| Name | Type |
| - | - |
| `toolkit?` | `str \| None` |

**Returns**

`List[RegisteredCustomTool]` — Array of registered custom tools

***

### custom\_toolkits()

List all custom toolkits registered in this session.  Returns toolkits with their tools showing final slugs.

```python theme={null}
def custom_toolkits() -> List[RegisteredCustomToolkit]
```

**Returns**

`List[RegisteredCustomToolkit]`

***

### proxy\_execute()

Proxy an API call through Composio's auth layer.

```python theme={null}
def proxy_execute(toolkit: str, endpoint: str, method: Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH'], body: Any = ..., parameters: List[Dict[str, Any | None]] = ...) -> ToolRouterSessionProxyExecuteResponse
```

**Parameters**

| Name | Type |
| - | - |
| `toolkit` | `str` |
| `endpoint` | `str` |
| `method` | `Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH']` |
| `body?` | `Any` |
| `parameters?` | `List[Dict[str, Any \| None]]` |

**Returns**

`ToolRouterSessionProxyExecuteResponse` — The proxied API response with `result_type="completed"`, or `result_type="blocked"` with the hook's `message` when a session hook blocked the request (it then has no `status`)

**Raises**

* `ToolInputRequiredError` — If the call needs input from the user before it can run. Nothing was executed.

***

### update()

Partially update the session configuration.  Only the fields provided are changed; omitted fields are preserved. For each policy block `None` removes the stored override (which can increase access: `toolkits=None` restores the unrestricted default, while `toolkits={"enable": []}` denies every app toolkit and is sent as-is). Supplied `tools`, `auth_configs` and `connected_accounts` maps replace the stored map entirely. Inside `manage_connections`, `callback_url=None` removes only the stored callback URL. Experimental `instant` accepts `False` to disable billed access or an object to set its filters; it does not accept `None`. Any object, even one that only sets `return_instant_charge` or `return_prices_in_search`, re-enables Instant usage on a Session set to `False`. `proxy_execute` takes a bool or `{"enable": bool}`; `True` exposes the `COMPOSIO_PROXY_EXECUTE` meta tool, `False` also turns off the sandbox `proxy_execute()` helper, and `None` removes the stored block. `hooks` replaces the whole list of hooks, and `None` removes every hook. `hooks` cannot be combined with `experimental={'session_config_id': ...}` (`hooks=None` counts).  By default the request carries no precondition: the last writer wins. Pass `expected_config_version` (for example this object's `config_version`) to make the update conditional: the API then applies it only when the stored version still matches, and a concurrent change raises `SessionConfigConflictError` (HTTP 409) instead of being overwritten. The API must support the `expected_config_version` field; otherwise it rejects the request with a 400. `expected_config_version=False` is the same as omitting it. The PATCH is never retried by the transport, so a 409 is reported exactly once. On conflict this object stays unchanged: re-fetch the session with `composio.sessions.use(session_id)` and retry against the fresh `config_version`.  `config`, `config_version` and `preload` are refreshed in place only after a successful response, and the updated `config` is returned.  `workbench` is a backwards-compatible alias for `sandbox`. Prefer `sandbox` in new code.  All other parameters use the same types as the generated `client.tool_router.session.patch()` method.

```python theme={null}
def update(toolkits: Union[session_patch_params.Toolkits | None, 'Omit'] = ..., instant: Union[Literal[False], ToolRouterInstantConfig, 'Omit'] = ..., tools: Union[Dict[str, session_patch_params.Tools | None], 'Omit'] = ..., tags: Union[session_patch_params.Tags | None, 'Omit'] = ..., auth_configs: Union[Dict[str, str | None], 'Omit'] = ..., connected_accounts: Union[Dict[str, SequenceNotStr[str | None]], 'Omit'] = ..., manage_connections: Union[session_patch_params.ManageConnections | None, ToolRouterUpdateManageConnectionsConfig | None, 'Omit'] = ..., sandbox: Union[session_patch_params.Workbench | None, 'Omit'] = ..., workbench: Union[session_patch_params.Workbench | None, 'Omit'] = ..., multi_account: Union[session_patch_params.MultiAccount | None, ToolRouterUpdateMultiAccountConfig | None, 'Omit'] = ..., proxy_execute: Union[Union[bool, ToolRouterProxyExecuteConfig | None], 'Omit'] = ..., hooks: Union[List[ToolRouterHook | None], 'Omit'] = ..., preload: Union[session_patch_params.Preload | None, 'Omit'] = ..., search: Union[session_patch_params.Search | None, 'Omit'] = ..., execute: Union[session_patch_params.Execute | None, 'Omit'] = ..., experimental: Union[session_patch_params.Experimental | None, ToolRouterUpdateExperimentalConfig | None, 'Omit'] = ..., expected_config_version: Union[int, None, Literal[False]] = ...) -> ToolRouterSessionConfig
```

**Parameters**

| Name | Type |
| - | - |
| `toolkits?` | `Union[session_patch_params.Toolkits \| None, 'Omit']` |
| `instant?` | `Union[Literal[False], ToolRouterInstantConfig, 'Omit']` |
| `tools?` | `Union[Dict[str, session_patch_params.Tools \| None], 'Omit']` |
| `tags?` | `Union[session_patch_params.Tags \| None, 'Omit']` |
| `auth_configs?` | `Union[Dict[str, str \| None], 'Omit']` |
| `connected_accounts?` | `Union[Dict[str, SequenceNotStr[str \| None]], 'Omit']` |
| `manage_connections?` | `Union[session_patch_params.ManageConnections \| None, ToolRouterUpdateManageConnectionsConfig \| None, 'Omit']` |
| `sandbox?` | `Union[session_patch_params.Workbench \| None, 'Omit']` |
| `workbench?` | `Union[session_patch_params.Workbench \| None, 'Omit']` |
| `multi_account?` | `Union[session_patch_params.MultiAccount \| None, ToolRouterUpdateMultiAccountConfig \| None, 'Omit']` |
| `proxy_execute?` | `Union[Union[bool, ToolRouterProxyExecuteConfig \| None], 'Omit']` |
| `hooks?` | `Union[List[ToolRouterHook \| None], 'Omit']` |
| `preload?` | `Union[session_patch_params.Preload \| None, 'Omit']` |
| `search?` | `Union[session_patch_params.Search \| None, 'Omit']` |
| `execute?` | `Union[session_patch_params.Execute \| None, 'Omit']` |
| `experimental?` | `Union[session_patch_params.Experimental \| None, ToolRouterUpdateExperimentalConfig \| None, 'Omit']` |
| `expected_config_version?` | `Union[int, None, Literal[False]]` |

**Returns**

`ToolRouterSessionConfig`

***

### list\_config\_history()

List the configuration history of this session, newest first.  Every `update()` records a new config version; this returns those versions with cursor-based pagination.

```python theme={null}
def list_config_history(query: session_config_history_params.SessionConfigHistoryParams = ...) -> session_config_history_response.SessionConfigHistoryResponse
```

**Parameters**

| Name | Type |
| - | - |
| `query?` | `session_config_history_params.SessionConfigHistoryParams` |

**Returns**

`session_config_history_response.SessionConfigHistoryResponse` — The config versions under `.items` plus pagination fields.

**Example**

```python theme={null}
history = session.list_config_history(limit=10)
for entry in history.items:
    print(entry.version, entry.is_current)
```

***

### delete()

Delete this session.  Deleted sessions immediately stop being retrievable or executable. An already-deleted session surfaces the backend 404.

```python theme={null}
def delete() -> ToolRouterSessionDeleteResponse
```

**Returns**

`ToolRouterSessionDeleteResponse`

***

[View source](https://github.com/composiohq/composio/blob/next/python/composio/core/models/tool_router_session.py#L311)
