Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

docs: use OpenAI agents tool names

Dhawal Upadhyaye42ff4b0786c
diff --git a/docs/content/changelog/05-07-26-toolrouter-preload-direct-tools.mdx b/docs/content/changelog/05-07-26-toolrouter-preload-direct-tools.mdx
index da8d80cd1..f5bc70803 100644
--- a/docs/content/changelog/05-07-26-toolrouter-preload-direct-tools.mdx
+++ b/docs/content/changelog/05-07-26-toolrouter-preload-direct-tools.mdx
@@ -22,8 +22,12 @@ generally fewer than 20 tools, to avoid context bloat.
<Tab value="Python">
```python
from composio import Composio
+from composio_openai_agents import OpenAIAgentsProvider
-composio = Composio(api_key="your_api_key")
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
session = composio.create(
user_id="user_123",
@@ -44,8 +48,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio } from '@composio/core';
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
-const composio = new Composio({ apiKey: 'your_api_key' });
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
const session = await composio.create('user_123', {
toolkits: ['gmail'],
@@ -74,8 +82,12 @@ disable session meta tools by default.
<Tab value="Python">
```python
from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
+from composio_openai_agents import OpenAIAgentsProvider
-composio = Composio(api_key="your_api_key")
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
session = composio.create(
user_id="user_123",
@@ -97,8 +109,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio, SessionPreset } from '@composio/core';
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
-const composio = new Composio({ apiKey: 'your_api_key' });
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
const session = await composio.create('user_123', {
toolkits: ['gmail'],
@@ -125,8 +141,12 @@ can be enabled alongside the preset:
<Tab value="Python">
```python
from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
+from composio_openai_agents import OpenAIAgentsProvider
-composio = Composio(api_key="your_api_key")
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
session = composio.create(
user_id="user_123",
@@ -153,8 +173,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio, SessionPreset } from '@composio/core';
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
-const composio = new Composio({ apiKey: 'your_api_key' });
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
const session = await composio.create('user_123', {
toolkits: ['gmail'],
diff --git a/docs/content/docs/configuring-sessions.mdx b/docs/content/docs/configuring-sessions.mdx
index 524449262..8ec9df0c9 100644
--- a/docs/content/docs/configuring-sessions.mdx
+++ b/docs/content/docs/configuring-sessions.mdx
@@ -114,6 +114,14 @@ Requires `@composio/core` ≥ `0.9.0` (TypeScript) or `composio` ≥ `0.13.0`
<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
<Tab value="Python">
```python
+from composio import Composio
+from composio_openai_agents import OpenAIAgentsProvider
+
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
+
session = composio.create(
user_id="user_123",
toolkits=["gmail"],
@@ -136,7 +144,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio } from '@composio/core';
-const composio = new Composio({ apiKey: 'your_api_key' });
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
// ---cut---
const session = await composio.create("user_123", {
toolkits: ["gmail"],
@@ -177,7 +190,13 @@ context bloat.
<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
<Tab value="Python">
```python
-from composio import SESSION_PRESET_DIRECT_TOOLS
+from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
+from composio_openai_agents import OpenAIAgentsProvider
+
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
session = composio.create(
user_id="user_123",
@@ -202,7 +221,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio, SessionPreset } from '@composio/core';
-const composio = new Composio({ apiKey: 'your_api_key' });
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
// ---cut---
const session = await composio.create("user_123", {
toolkits: ["gmail"],
@@ -232,7 +256,13 @@ support available:
<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
<Tab value="Python">
```python
-from composio import SESSION_PRESET_DIRECT_TOOLS
+from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
+from composio_openai_agents import OpenAIAgentsProvider
+
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
session = composio.create(
user_id="user_123",
@@ -266,7 +296,12 @@ print([tool.name for tool in tools])
<Tab value="TypeScript">
```typescript
import { Composio, SessionPreset } from '@composio/core';
-const composio = new Composio({ apiKey: 'your_api_key' });
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+
+const composio = new Composio({
+ apiKey: 'your_api_key',
+ provider: new OpenAIAgentsProvider(),
+});
// ---cut---
const session = await composio.create("user_123", {
toolkits: ["gmail"],
diff --git a/docs/content/docs/toolkits/custom-tools-and-toolkits.mdx b/docs/content/docs/toolkits/custom-tools-and-toolkits.mdx
index e6e74cdb8..653ec740c 100644
--- a/docs/content/docs/toolkits/custom-tools-and-toolkits.mdx
+++ b/docs/content/docs/toolkits/custom-tools-and-toolkits.mdx
@@ -98,8 +98,12 @@ const getUserProfile = experimental_createTool("GET_USER_PROFILE", {
from pydantic import BaseModel, Field
from composio import Composio
+from composio_openai_agents import OpenAIAgentsProvider
-composio = Composio(api_key="your_api_key")
+composio = Composio(
+ api_key="your_api_key",
+ provider=OpenAIAgentsProvider(),
+)
class UserLookupInput(BaseModel):
@@ -497,9 +501,13 @@ preload applies to all tools in that toolkit; set `preload: false` /
<Tab value="TypeScript">
```typescript
import { Composio, experimental_createTool } from "@composio/core";
+import { OpenAIAgentsProvider } from "@composio/openai-agents";
import { z } from "zod/v3";
-const composio = new Composio({ apiKey: "your_api_key" });
+const composio = new Composio({
+ apiKey: "your_api_key",
+ provider: new OpenAIAgentsProvider(),
+});
const replyGuide = experimental_createTool("GET_REPLY_STYLE_GUIDE", {
name: "Get reply style guide",