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, 04:45 UTC
| 1 | --- |
| 2 | title: Toolkits |
| 3 | description: "Toolkit and tool management" |
| 4 | --- |
| 5 | |
| 6 | {/* Auto-generated from OpenAPI spec. Edit the overview at api-overviews/toolkits.mdx, not this file. */} |
| 7 | |
| 8 | A toolkit is a collection of related tools for a single app, like `gmail`, `github`, or `slack`. Each toolkit groups the actions for that service, its authentication requirements, and the trigger types it exposes. |
| 9 | |
| 10 | Reach for these endpoints when you want to: |
| 11 | |
| 12 | - List the toolkits in the catalog, sorted by popularity, to browse what is available before configuring a session. |
| 13 | - Fetch a single toolkit by `slug` for its name, logo, categories, and metadata. |
| 14 | - Fetch several toolkits at once with the multi endpoint. |
| 15 | - List the available toolkit categories to filter the catalog by use case. |
| 16 | - Read the toolkits changelog to track when tools or schemas change. |
| 17 | |
| 18 | These endpoints authenticate with your project API key in the `x-api-key` header. |
| 19 | |
| 20 | <Callout type="info"> |
| 21 | Tools within a toolkit are versioned. When you execute a tool, resolve to a known version with `toolkit_versions=latest` or a pinned dated version. See the [toolkit versioning migration guide](/docs/migration-guide/toolkit-versioning). |
| 22 | </Callout> |
| 23 | |
| 24 | To browse toolkits visually, see the [toolkits catalog](/toolkits). For the concepts and SDK usage, see [Tools and toolkits](/docs/how-composio-works) and [Configuring sessions](/docs/configuring-sessions). |
| 25 | |
| 26 | ## Endpoints |
| 27 | |
| 28 | <ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/custom/toolkits","pathV3":"/api/v3/custom/toolkits","summary":"Create a custom toolkit","href":"/reference/api-reference/toolkits/postCustomToolkits"},{"method":"DELETE","pathV31":"/api/v3.1/custom/toolkits/{slug}","pathV3":"/api/v3/custom/toolkits/{slug}","summary":"Delete a custom toolkit","href":"/reference/api-reference/toolkits/deleteCustomToolkitsBySlug"},{"method":"PATCH","pathV31":"/api/v3.1/custom/toolkits/{slug}","pathV3":"/api/v3/custom/toolkits/{slug}","summary":"Update a custom toolkit","href":"/reference/api-reference/toolkits/patchCustomToolkitsBySlug"},{"method":"POST","pathV31":"/api/v3.1/toolkits/{toolkit_slug}/scopes/recommended","pathV3":"/api/v3/toolkits/{toolkit_slug}/scopes/recommended","summary":"Get required scopes","href":"/reference/api-reference/toolkits/recommendToolkitScopes"},{"method":"GET","pathV31":"/api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context","pathV3":"/api/v3/toolkits/{toolkit_slug}/scopes/grant_context","summary":"List grant contexts","href":"/reference/api-reference/toolkits/recommendToolkitScopesGrantContext"},{"method":"GET","pathV31":"/api/v3.1/toolkits","pathV3":"/api/v3/toolkits","summary":"List available toolkits","href":"/reference/api-reference/toolkits/getToolkits"},{"method":"GET","pathV31":"/api/v3.1/toolkits/categories","pathV3":"/api/v3/toolkits/categories","summary":"List toolkit categories","href":"/reference/api-reference/toolkits/getToolkitsCategories"},{"method":"POST","pathV31":"/api/v3.1/custom/toolkits/upsert","pathV3":"/api/v3/custom/toolkits/upsert","summary":"Upsert a custom toolkit (DEPRECATED)","href":"/reference/api-reference/toolkits/postCustomToolkitsUpsert","legacy":true},{"method":"POST","pathV31":"/api/v3.1/custom/toolkits/sync","pathV3":"/api/v3/custom/toolkits/sync","summary":"Sync a custom toolkit","href":"/reference/api-reference/toolkits/postCustomToolkitsSync"},{"method":"GET","pathV31":"/api/v3.1/toolkits/{slug}","pathV3":"/api/v3/toolkits/{slug}","summary":"Get toolkit by slug","href":"/reference/api-reference/toolkits/getToolkitsBySlug"},{"method":"POST","pathV31":"/api/v3.1/toolkits/multi","pathV3":"/api/v3/toolkits/multi","summary":"Fetch multiple toolkits","href":"/reference/api-reference/toolkits/postToolkitsMulti"},{"method":"GET","pathV31":"/api/v3.1/toolkits/changelog","pathV3":"/api/v3/toolkits/changelog","summary":"Get toolkits changelog","href":"/reference/api-reference/toolkits/getToolkitsChangelog"}]} /> |