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: update readme (#1977)
Prathit committed
Sep 28, 2025 at 04:02 UTC
942ec77778093bfa48169578f978fca5468c35d7
2 files changed
+85
-5
README.md
+85
-5
@@ -1,10 +1,19 @@
1
-
1
+
2
+<div align="center">
3
+
4
+<img src="https://raw.githubusercontent.com/ComposioHQ/composio/next/public/logo.png" alt="Composio Logo" width="200" height="auto" style="margin-bottom: 20px;"/>
5
+
6
7
# Composio SDK
8
5
-| This is the preview for our next generation sdk, you can learn more about them here and how to move here https://v3.docs.composio.dev/docs/migration
9
+Skills that evolve for your Agents
10
7
-_if you are looking for the older sdk, you can find them [here](https://github.com/ComposioHQ/composio/tree/master)_
11
+[🌐 Website](https://composio.dev) • [📚 Documentation](https://docs.composio.dev)
12
+
13
+[](https://github.com/ComposioHQ/composio/stargazers)
14
+[](https://pypi.org/project/composio/)
15
+[](https://www.npmjs.com/package/@composio/core)
16
+</div>
17
18
This repository contains the official Software Development Kits (SDKs) for Composio, providing seamless integration capabilities across multiple programming languages.
19
@@ -33,7 +42,7 @@ yarn add @composio/core@next
42
pnpm add @composio/core@next
43
```
44
36
-Quick start:
45
+#### Quick start:
46
47
```typescript
48
import { Composio } from '@composio/core';
@@ -43,6 +52,44 @@ const composio = new Composio({
52
});
53
```
54
55
+#### Simple Agent with OpenAI
56
+
57
+```bash
58
+npm install @composio/openai
59
+```
60
+
61
+```typescript
62
+import { Composio } from '@composio/core';
63
+import { OpenAIResponsesProvider, OpenAIProvider } from '@composio/openai';
64
+import { OpenAI } from 'openai';
65
+
66
+const openai = new OpenAI();
67
+
68
+const composioForCompletions = new Composio({ provider: new OpenAIProvider() });
69
+
70
+const userId = 'user@acme.org'
71
+
72
+const toolsForCompletions = await composioForCompletions.tools.get(userId, {
73
+ toolkits: ['HACKERNEWS'],
74
+});
75
+
76
+const completion = await openai.chat.completions.create({
77
+ model: 'gpt-5',
78
+ messages: [
79
+ {
80
+ role: 'user',
81
+ content: 'What is the latest hackernews post about?',
82
+ },
83
+ ],
84
+ tools: toolsForCompletions,
85
+});
86
+
87
+const newResult = await composioForCompletions.provider.handleToolCalls(userId, completion);
88
+
89
+console.log(JSON.stringify(newResult, null, 2));
90
+// will return the raw response from the HACKERNEWS API.
91
+```
92
+
93
### Python SDK Installation
94
95
```bash
@@ -53,7 +100,7 @@ pip install composio
100
poetry add composio
101
```
102
56
-Quick start:
103
+#### Quick start:
104
105
```python
106
from composio import Composio
@@ -64,6 +111,38 @@ composio = Composio(
111
)
112
```
113
114
+#### Simple Agent with OpenAI
115
+
116
+```bash
117
+pip install composio_openai>=0.8.0
118
+```
119
+
120
+```python
121
+from openai import OpenAI
122
+from composio import Composio
123
+from composio_openai import OpenAIProvider
124
+
125
+# Initialize Composio client with OpenAI Provider
126
+composio = Composio(provider=OpenAIProvider())
127
+openai = OpenAI()
128
+
129
+user_id = "user@acme.org"
130
+tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])
131
+
132
+response = openai.chat.completions.create(
133
+ model="gpt-5",
134
+ tools=tools,
135
+ messages=[
136
+ {"role": "user", "content": "What's the latest Hackernews post about?"},
137
+ ],
138
+)
139
+
140
+# Execute the function calls.
141
+result = composio.provider.handle_tool_calls(response=response, user_id=user_id)
142
+print(result)
143
+# will return the raw response from the HACKERNEWS API.
144
+```
145
+
146
For more detailed usage instructions and examples, please refer to each SDK's specific documentation.
147
148
### Open API Specification
@@ -93,6 +172,7 @@ The Python SDK offers a Pythonic interface to Composio's services, making it eas
172
173
For detailed information about the Python SDK, please refer to the [Python SDK Documentation](/python/README.md).
174
175
+_if you are looking for the older sdk, you can find them [here](https://github.com/ComposioHQ/composio/tree/master)_
176
177
## Contributing
178
public/logo.png
Binary files /dev/null and b/public/logo.png differ