wehub-resource-sync
224 lines
6.4 KiB
Plaintext
224 lines
6.4 KiB
Plaintext
---
|
|
title: "Session"
|
|
description: "A Composio session \u2014 the object returned by `composio.create(...)` / `composio.use(...)`. Use it to fetch session-scoped tools, authorize toolkits,..."
|
|
---
|
|
|
|
## Properties
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| `session_id` | `str` |
|
|
| `experimental` | `'ToolRouterSessionExperimental'` |
|
|
| `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
|
|
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
|
|
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
|
|
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
|
|
def search(query: str, model: str | None = ...) -> SessionSearchResponse
|
|
```
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| `query` | `str` |
|
|
| `model?` | `str \| None` |
|
|
|
|
**Returns**
|
|
|
|
`SessionSearchResponse`
|
|
|
|
---
|
|
|
|
### execute()
|
|
|
|
Execute a tool within the session. For custom tools, accepts the original slug (e.g. "GREP") or the full slug (e.g. "LOCAL_GREP"). Custom tools are executed in-process; remote tools are sent to the Composio backend.
|
|
|
|
```python
|
|
def execute(tool_slug: str, arguments: Dict[str, Any | None] = ..., account: str | None = ...) -> SessionExecuteResponse
|
|
```
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| `tool_slug` | `str` |
|
|
| `arguments?` | `Dict[str, Any \| None]` |
|
|
| `account?` | `str \| None` |
|
|
|
|
**Returns**
|
|
|
|
`SessionExecuteResponse`
|
|
|
|
---
|
|
|
|
### custom_tools()
|
|
|
|
List all custom tools registered in this session. Returns tools with their final slugs, schemas, and resolved toolkit.
|
|
|
|
```python
|
|
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
|
|
def custom_toolkits() -> List[RegisteredCustomToolkit]
|
|
```
|
|
|
|
**Returns**
|
|
|
|
`List[RegisteredCustomToolkit]`
|
|
|
|
---
|
|
|
|
### proxy_execute()
|
|
|
|
Proxy an API call through Composio's auth layer.
|
|
|
|
```python
|
|
def proxy_execute(toolkit: str, endpoint: str, method: Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH'], body: Any = ..., parameters: List[Dict[str, Any | None]] = ...) -> SessionProxyExecuteResponse
|
|
```
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| `toolkit` | `str` |
|
|
| `endpoint` | `str` |
|
|
| `method` | `Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH']` |
|
|
| `body?` | `Any` |
|
|
| `parameters?` | `List[Dict[str, Any \| None]]` |
|
|
|
|
**Returns**
|
|
|
|
`SessionProxyExecuteResponse` — Proxied API response
|
|
|
|
---
|
|
|
|
### update()
|
|
|
|
Partially update the session configuration. Only the fields provided will be changed; omitted fields are preserved. Mutates this session's ``preload`` in-place. Pass ``None`` for ``manage_connections``, ``sandbox``/``workbench``, or ``multi_account`` to clear the stored value. ``workbench`` is a backwards-compatible alias for ``sandbox``. Prefer ``sandbox`` in new code. All parameters use the same types as the Stainless-generated ``client.tool_router.session.patch()`` method.
|
|
|
|
```python
|
|
def update(toolkits: Union[session_patch_params.Toolkits, 'Omit'] = ..., tools: Union[Dict[str, session_patch_params.Tools], 'Omit'] = ..., tags: Union[session_patch_params.Tags, 'Omit'] = ..., auth_configs: Union[Dict[str, str], 'Omit'] = ..., connected_accounts: Union[Dict[str, SequenceNotStr[str | None]], 'Omit'] = ..., manage_connections: Union[session_patch_params.ManageConnections | 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, 'Omit'] = ..., preload: Union[session_patch_params.Preload, 'Omit'] = ...) -> None
|
|
```
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| `toolkits?` | `Union[session_patch_params.Toolkits, 'Omit']` |
|
|
| `tools?` | `Union[Dict[str, session_patch_params.Tools], 'Omit']` |
|
|
| `tags?` | `Union[session_patch_params.Tags, 'Omit']` |
|
|
| `auth_configs?` | `Union[Dict[str, str], 'Omit']` |
|
|
| `connected_accounts?` | `Union[Dict[str, SequenceNotStr[str \| None]], 'Omit']` |
|
|
| `manage_connections?` | `Union[session_patch_params.ManageConnections \| 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, 'Omit']` |
|
|
| `preload?` | `Union[session_patch_params.Preload, 'Omit']` |
|
|
|
|
---
|
|
|
|
### delete()
|
|
|
|
Delete this session. Deleted sessions immediately stop being retrievable or executable. An already-deleted session surfaces the backend 404.
|
|
|
|
```python
|
|
def delete() -> ToolRouterSessionDeleteResponse
|
|
```
|
|
|
|
**Returns**
|
|
|
|
`ToolRouterSessionDeleteResponse`
|
|
|
|
---
|
|
|
|
[View source](https://github.com/composiohq/composio/blob/next/python/composio/core/models/tool_router_session.py#L85)
|