Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 19:45 UTC
Document version-placeholder permission endpoints
Palash Kala committed
Jun 22, 2026 at 11:36 UTC
9f09b13f71d4fe6dc50422d6c72a7ec24a447922
1 file changed
+92
-104
docs/content/reference/authentication/project-api-key-permissions.mdx
+92
-104
@@ -23,6 +23,8 @@ Default project API keys keep full project API key access. Scoped project API ke
23
24
Some read routes use `POST` because the request body carries filters or lookup input. The access level is based on what the route does, not only the HTTP method.
25
26
+Endpoint paths use `{version}` as a placeholder for the API version.
27
+
28
## Permission areas
29
30
Jump to each permission area to see the routes it covers.
@@ -46,12 +48,12 @@ View and modify auth configs.
48
49
| Access | Method | Endpoint |
50
|---|---|---|
49
-| Read | `GET` | `/api/v3/auth_configs` |
50
-| Read | `GET` | `/api/v3/auth_configs/{nanoid}` |
51
-| Write | `POST` | `/api/v3/auth_configs` |
52
-| Write | `PATCH` | `/api/v3/auth_configs/{nanoid}` |
53
-| Write | `DELETE` | `/api/v3/auth_configs/{nanoid}` |
54
-| Write | `PATCH` | `/api/v3/auth_configs/{nanoid}/{status}` |
51
+| Read | `GET` | `/api/{version}/auth_configs` |
52
+| Read | `GET` | `/api/{version}/auth_configs/{nanoid}` |
53
+| Write | `POST` | `/api/{version}/auth_configs` |
54
+| Write | `PATCH` | `/api/{version}/auth_configs/{nanoid}` |
55
+| Write | `DELETE` | `/api/{version}/auth_configs/{nanoid}` |
56
+| Write | `PATCH` | `/api/{version}/auth_configs/{nanoid}/{status}` |
57
58
## Connected accounts
59
@@ -59,15 +61,15 @@ View and manage connected accounts.
61
62
| Access | Method | Endpoint |
63
|---|---|---|
62
-| Read | `GET` | `/api/v3/connected_accounts` |
63
-| Read | `GET` | `/api/v3/connected_accounts/{nanoid}` |
64
-| Write | `POST` | `/api/v3/connected_accounts` |
65
-| Write | `POST` | `/api/v3/connected_accounts/link` |
66
-| Write | `PATCH` | `/api/v3/connected_accounts/{nanoid}` |
67
-| Write | `PATCH` | `/api/v3/connected_accounts/{nanoid}/status` |
68
-| Write | `POST` | `/api/v3/connected_accounts/{nanoid}/refresh` |
69
-| Write | `DELETE` | `/api/v3/connected_accounts/{nanoid}` |
70
-| Write | `POST` | `/api/v3.1/connected_accounts/{nanoid}/revoke` |
64
+| Read | `GET` | `/api/{version}/connected_accounts` |
65
+| Read | `GET` | `/api/{version}/connected_accounts/{nanoid}` |
66
+| Write | `POST` | `/api/{version}/connected_accounts` |
67
+| Write | `POST` | `/api/{version}/connected_accounts/link` |
68
+| Write | `PATCH` | `/api/{version}/connected_accounts/{nanoid}` |
69
+| Write | `PATCH` | `/api/{version}/connected_accounts/{nanoid}/status` |
70
+| Write | `POST` | `/api/{version}/connected_accounts/{nanoid}/refresh` |
71
+| Write | `DELETE` | `/api/{version}/connected_accounts/{nanoid}` |
72
+| Write | `POST` | `/api/{version}/connected_accounts/{nanoid}/revoke` |
73
74
## Tools
75
@@ -75,19 +77,13 @@ View tool definitions, inputs, scopes, and versions.
77
78
| Access | Method | Endpoint |
79
|---|---|---|
78
-| Read | `GET` | `/api/v3/tools` |
79
-| Read | `GET` | `/api/v3/tools/enum` |
80
-| Read | `GET` | `/api/v3/tools/{tool_slug}` |
81
-| Read | `GET` | `/api/v3/tools/{tool_slug}/get_latest_version` |
82
-| Read | `GET` | `/api/v3/tools/scopes/required` |
83
-| Read | `GET` | `/api/v3/tools/get_scopes_required` |
84
-| Read | `POST` | `/api/v3/tools/execute/{tool_slug}/input` |
85
-| Read | `GET` | `/api/v3.1/tools` |
86
-| Read | `GET` | `/api/v3.1/tools/enum` |
87
-| Read | `GET` | `/api/v3.1/tools/{tool_slug}` |
88
-| Read | `GET` | `/api/v3.1/tools/scopes/required` |
89
-| Read | `GET` | `/api/v3.1/tools/get_scopes_required` |
90
-| Read | `POST` | `/api/v3.1/tools/execute/{tool_slug}/input` |
80
+| Read | `GET` | `/api/{version}/tools` |
81
+| Read | `GET` | `/api/{version}/tools/enum` |
82
+| Read | `GET` | `/api/{version}/tools/{tool_slug}` |
83
+| Read | `GET` | `/api/{version}/tools/{tool_slug}/get_latest_version` |
84
+| Read | `GET` | `/api/{version}/tools/scopes/required` |
85
+| Read | `GET` | `/api/{version}/tools/get_scopes_required` |
86
+| Read | `POST` | `/api/{version}/tools/execute/{tool_slug}/input` |
87
88
## Tool execution
89
@@ -95,11 +91,10 @@ Execute predefined Composio tools.
91
92
| Access | Method | Endpoint |
93
|---|---|---|
98
-| Write | `POST` | `/api/v3/tools/execute/{tool_slug}` |
99
-| Write | `POST` | `/api/v3.1/tools/execute/{tool_slug}` |
100
-| Write | `POST` | `/api/v3/files/upload/request` |
101
-| Write | `POST` | `/api/v3/files/upload/response` |
102
-| Write | `GET` | `/api/v3/files/list` |
94
+| Write | `POST` | `/api/{version}/tools/execute/{tool_slug}` |
95
+| Write | `POST` | `/api/{version}/files/upload/request` |
96
+| Write | `POST` | `/api/{version}/files/upload/response` |
97
+| Write | `GET` | `/api/{version}/files/list` |
98
99
## Proxy execute
100
@@ -109,8 +104,8 @@ Proxy execute is separate from tool execution. Grant it only when your applicati
104
105
| Access | Method | Endpoint |
106
|---|---|---|
112
-| Write | `POST` | `/api/v3.1/tools/execute/proxy` |
113
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/proxy_execute` |
107
+| Write | `POST` | `/api/{version}/tools/execute/proxy` |
108
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/proxy_execute` |
109
110
## Toolkits
111
@@ -118,11 +113,11 @@ View and install toolkits.
113
114
| Access | Method | Endpoint |
115
|---|---|---|
121
-| Read | `GET` | `/api/v3/toolkits` |
122
-| Read | `GET` | `/api/v3/toolkits/{slug}` |
123
-| Read | `GET` | `/api/v3/toolkits/categories` |
124
-| Read | `GET` | `/api/v3/toolkits/changelog` |
125
-| Write | `POST` | `/api/v3/toolkits/multi` |
116
+| Read | `GET` | `/api/{version}/toolkits` |
117
+| Read | `GET` | `/api/{version}/toolkits/{slug}` |
118
+| Read | `GET` | `/api/{version}/toolkits/categories` |
119
+| Read | `GET` | `/api/{version}/toolkits/changelog` |
120
+| Write | `POST` | `/api/{version}/toolkits/multi` |
121
122
## Triggers
123
@@ -130,17 +125,17 @@ View trigger types, manage trigger instances, and subscribe to trigger events. T
125
126
| Access | Method | Endpoint |
127
|---|---|---|
133
-| Read | `GET` | `/api/v3/triggers_types` |
134
-| Read | `GET` | `/api/v3/triggers_types/{slug}` |
135
-| Read | `GET` | `/api/v3/triggers_types/list/enum` |
136
-| Read | `GET` | `/api/v3/trigger_instances/active` |
137
-| Read | `GET` | `/api/v3/cli/realtime/credentials` |
138
-| Read | `POST` | `/api/v3/cli/realtime/auth` |
139
-| Read | `GET` | `/api/v3/internal/sdk/realtime/credentials` |
140
-| Read | `POST` | `/api/v3/internal/sdk/realtime/auth` |
141
-| Write | `POST` | `/api/v3/trigger_instances/{slug}/upsert` |
142
-| Write | `PATCH` | `/api/v3/trigger_instances/manage/{triggerId}` |
143
-| Write | `DELETE` | `/api/v3/trigger_instances/manage/{triggerId}` |
128
+| Read | `GET` | `/api/{version}/triggers_types` |
129
+| Read | `GET` | `/api/{version}/triggers_types/{slug}` |
130
+| Read | `GET` | `/api/{version}/triggers_types/list/enum` |
131
+| Read | `GET` | `/api/{version}/trigger_instances/active` |
132
+| Read | `GET` | `/api/{version}/cli/realtime/credentials` |
133
+| Read | `POST` | `/api/{version}/cli/realtime/auth` |
134
+| Read | `GET` | `/api/{version}/internal/sdk/realtime/credentials` |
135
+| Read | `POST` | `/api/{version}/internal/sdk/realtime/auth` |
136
+| Write | `POST` | `/api/{version}/trigger_instances/{slug}/upsert` |
137
+| Write | `PATCH` | `/api/{version}/trigger_instances/manage/{triggerId}` |
138
+| Write | `DELETE` | `/api/{version}/trigger_instances/manage/{triggerId}` |
139
140
## Webhooks
141
@@ -148,20 +143,20 @@ View and manage webhook endpoints and subscriptions.
143
144
| Access | Method | Endpoint |
145
|---|---|---|
151
-| Read | `GET` | `/api/v3/webhook_endpoints` |
152
-| Read | `GET` | `/api/v3/webhook_endpoints/{nano_id}` |
153
-| Read | `GET` | `/api/v3/webhook_endpoints/schema` |
154
-| Read | `GET` | `/api/v3/webhook_subscriptions` |
155
-| Read | `GET` | `/api/v3/webhook_subscriptions/{id}` |
156
-| Read | `GET` | `/api/v3/webhook_subscriptions/event_types` |
157
-| Write | `POST` | `/api/v3/webhook_endpoints` |
158
-| Write | `POST` | `/api/v3/webhook_endpoints/{nano_id}` |
159
-| Write | `PATCH` | `/api/v3/webhook_endpoints/{nano_id}` |
160
-| Write | `DELETE` | `/api/v3/webhook_endpoints/{nano_id}` |
161
-| Write | `POST` | `/api/v3/webhook_subscriptions` |
162
-| Write | `PATCH` | `/api/v3/webhook_subscriptions/{id}` |
163
-| Write | `DELETE` | `/api/v3/webhook_subscriptions/{id}` |
164
-| Write | `POST` | `/api/v3/webhook_subscriptions/{id}/rotate_secret` |
146
+| Read | `GET` | `/api/{version}/webhook_endpoints` |
147
+| Read | `GET` | `/api/{version}/webhook_endpoints/{nano_id}` |
148
+| Read | `GET` | `/api/{version}/webhook_endpoints/schema` |
149
+| Read | `GET` | `/api/{version}/webhook_subscriptions` |
150
+| Read | `GET` | `/api/{version}/webhook_subscriptions/{id}` |
151
+| Read | `GET` | `/api/{version}/webhook_subscriptions/event_types` |
152
+| Write | `POST` | `/api/{version}/webhook_endpoints` |
153
+| Write | `POST` | `/api/{version}/webhook_endpoints/{nano_id}` |
154
+| Write | `PATCH` | `/api/{version}/webhook_endpoints/{nano_id}` |
155
+| Write | `DELETE` | `/api/{version}/webhook_endpoints/{nano_id}` |
156
+| Write | `POST` | `/api/{version}/webhook_subscriptions` |
157
+| Write | `PATCH` | `/api/{version}/webhook_subscriptions/{id}` |
158
+| Write | `DELETE` | `/api/{version}/webhook_subscriptions/{id}` |
159
+| Write | `POST` | `/api/{version}/webhook_subscriptions/{id}/rotate_secret` |
160
161
## Observability
162
@@ -169,10 +164,10 @@ View execution logs and project usage summaries.
164
165
| Access | Method | Endpoint |
166
|---|---|---|
172
-| Read | `POST` | `/api/v3.1/logs/tool_execution` |
173
-| Read | `GET` | `/api/v3.1/logs/tool_execution/{id}` |
174
-| Read | `POST` | `/api/v3.1/project/usage/{entity_type}` |
175
-| Read | `POST` | `/api/v3.1/project/usage/summary` |
167
+| Read | `POST` | `/api/{version}/logs/tool_execution` |
168
+| Read | `GET` | `/api/{version}/logs/tool_execution/{id}` |
169
+| Read | `POST` | `/api/{version}/project/usage/{entity_type}` |
170
+| Read | `POST` | `/api/{version}/project/usage/summary` |
171
172
## Sessions
173
@@ -180,44 +175,37 @@ Create and operate sessions and MCP servers. This permission area covers MCP ser
175
176
| Access | Method | Endpoint |
177
|---|---|---|
183
-| Read | `GET` | `/api/v3/mcp/servers` |
184
-| Read | `GET` | `/api/v3/mcp/{id}` |
185
-| Read | `GET` | `/api/v3/mcp/app/{app_key}` |
186
-| Read | `GET` | `/api/v3/mcp/servers/{server_id}/instances` |
178
+| Read | `GET` | `/api/{version}/mcp/servers` |
179
+| Read | `GET` | `/api/{version}/mcp/{id}` |
180
+| Read | `GET` | `/api/{version}/mcp/app/{app_key}` |
181
+| Read | `GET` | `/api/{version}/mcp/servers/{server_id}/instances` |
182
| Read | `GET` | `/tool_router/{session_id}/mcp` |
188
-| Read | `GET` | `/api/v3/tool_router/session/{session_id}` |
189
-| Read | `GET` | `/api/v3/tool_router/session/{session_id}/toolkits` |
190
-| Read | `GET` | `/api/v3/tool_router/session/{session_id}/tools` |
191
-| Read | `GET` | `/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/items` |
192
-| Read | `GET` | `/api/v3.1/tool_router/session/{session_id}` |
193
-| Read | `GET` | `/api/v3.1/tool_router/session/{session_id}/config_history` |
194
-| Read | `GET` | `/api/v3.1/tool_router/session/{session_id}/tools` |
195
-| Write | `POST` | `/api/v3/mcp/servers` |
196
-| Write | `POST` | `/api/v3/mcp/servers/generate` |
197
-| Write | `POST` | `/api/v3/mcp/servers/custom` |
198
-| Write | `PATCH` | `/api/v3/mcp/{id}` |
199
-| Write | `DELETE` | `/api/v3/mcp/{id}` |
200
-| Write | `POST` | `/api/v3/mcp/servers/{server_id}/instances` |
201
-| Write | `DELETE` | `/api/v3/mcp/servers/{server_id}/instances/{instance_id}` |
202
-| Write | `POST` | `/api/v3/mcp/{server_id}/{transport}` |
203
-| Write | `DELETE` | `/api/v3/mcp/{server_id}/{transport}` |
183
+| Read | `GET` | `/api/{version}/tool_router/session/{session_id}` |
184
+| Read | `GET` | `/api/{version}/tool_router/session/{session_id}/toolkits` |
185
+| Read | `GET` | `/api/{version}/tool_router/session/{session_id}/tools` |
186
+| Read | `GET` | `/api/{version}/tool_router/session/{session_id}/mounts/{mount_id}/items` |
187
+| Read | `GET` | `/api/{version}/tool_router/session/{session_id}/config_history` |
188
+| Write | `POST` | `/api/{version}/mcp/servers` |
189
+| Write | `POST` | `/api/{version}/mcp/servers/generate` |
190
+| Write | `POST` | `/api/{version}/mcp/servers/custom` |
191
+| Write | `PATCH` | `/api/{version}/mcp/{id}` |
192
+| Write | `DELETE` | `/api/{version}/mcp/{id}` |
193
+| Write | `POST` | `/api/{version}/mcp/servers/{server_id}/instances` |
194
+| Write | `DELETE` | `/api/{version}/mcp/servers/{server_id}/instances/{instance_id}` |
195
+| Write | `POST` | `/api/{version}/mcp/{server_id}/{transport}` |
196
+| Write | `DELETE` | `/api/{version}/mcp/{server_id}/{transport}` |
197
| Write | `POST` | `/tool_router/{session_id}/mcp` |
198
| Write | `DELETE` | `/tool_router/{session_id}/mcp` |
206
-| Write | `POST` | `/api/v3/tool_router/session` |
207
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/execute` |
208
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/execute_meta` |
209
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/link` |
210
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/search` |
211
-| Write | `PATCH` | `/api/v3/tool_router/session/{session_id}` |
212
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/upload_url` |
213
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/download_url` |
214
-| Write | `POST` | `/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/delete` |
215
-| Write | `POST` | `/api/v3.1/tool_router/session` |
216
-| Write | `POST` | `/api/v3.1/tool_router/session/{session_id}/attach` |
217
-| Write | `POST` | `/api/v3.1/tool_router/session/{session_id}/execute` |
218
-| Write | `POST` | `/api/v3.1/tool_router/session/{session_id}/execute_meta` |
219
-| Write | `POST` | `/api/v3.1/tool_router/session/{session_id}/search` |
220
-| Write | `PATCH` | `/api/v3.1/tool_router/session/{session_id}` |
199
+| Write | `POST` | `/api/{version}/tool_router/session` |
200
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/execute` |
201
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/execute_meta` |
202
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/link` |
203
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/search` |
204
+| Write | `PATCH` | `/api/{version}/tool_router/session/{session_id}` |
205
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/mounts/{mount_id}/upload_url` |
206
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/mounts/{mount_id}/download_url` |
207
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/mounts/{mount_id}/delete` |
208
+| Write | `POST` | `/api/{version}/tool_router/session/{session_id}/attach` |
209
210
## What to read next
211