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.

Update toolkitSlugs -> toolkit

haxzief4b2c8f9f4fb
diff --git a/docs/api/auth-configs.md b/docs/api/auth-configs.md
index 0c5bfacea..67098b691 100644
--- a/docs/api/auth-configs.md
+++ b/docs/api/auth-configs.md
@@ -14,7 +14,7 @@ const allAuthConfigs = await composio.authConfigs.list();
// List auth configs for a specific toolkit
const githubAuthConfigs = await composio.authConfigs.list({
- toolkitSlug: 'github'
+ toolkit: 'github',
});
```
@@ -44,7 +44,7 @@ console.log(authConfig.name); // Name of the auth config
**Throws:** ComposioAuthConfigNotFoundError if the auth config cannot be found
-### create(toolkitSlug, data)
+### create(toolkit, data)
Creates a new auth config for a toolkit.
@@ -58,12 +58,13 @@ const authConfig = await composio.authConfigs.create('github', {
**Parameters:**
-- `toolkitSlug` (string): The slug of the toolkit to create an auth config for
+- `toolkit` (string): The slug of the toolkit to create an auth config for
- `data` (AuthConfigCreateParams): The parameters for creating the auth config
**Returns:** Promise<AuthConfigCreateResponse> - The created auth config
**Throws:**
+
- ValidationError if the parameters fail validation
- ComposioToolNotFoundError if the toolkit cannot be found
@@ -114,10 +115,10 @@ await composio.authConfigs.delete('auth_config_123');
```typescript
interface AuthConfigListParams {
- cursor?: string; // Pagination cursor
- limit?: number; // Limit the number of results
- orderBy?: string; // Order by field
- toolkitSlug?: string; // Filter by toolkit slug
+ cursor?: string; // Pagination cursor
+ limit?: number; // Limit the number of results
+ orderBy?: string; // Order by field
+ toolkit?: string; // Filter by toolkit slug
}
```
@@ -126,8 +127,8 @@ interface AuthConfigListParams {
```typescript
interface AuthConfigListResponse {
items: AuthConfigRetrieveResponse[]; // List of auth configs
- nextCursor: string | null; // Pagination cursor
- totalPages: number; // Total number of pages
+ nextCursor: string | null; // Pagination cursor
+ totalPages: number; // Total number of pages
}
```
@@ -135,20 +136,21 @@ interface AuthConfigListResponse {
```typescript
interface AuthConfigRetrieveResponse {
- id: string; // Auth config ID
- name: string; // Name of the auth config
- type: AuthConfigType; // Type of auth config
- toolkit: { // Associated toolkit
- id: string; // Toolkit ID
- slug: string; // Toolkit slug
- name: string; // Toolkit name
+ id: string; // Auth config ID
+ name: string; // Name of the auth config
+ type: AuthConfigType; // Type of auth config
+ toolkit: {
+ // Associated toolkit
+ id: string; // Toolkit ID
+ slug: string; // Toolkit slug
+ name: string; // Toolkit name
};
authScheme: AuthSchemeType; // Auth scheme (e.g., 'oauth2', 'api_key')
- isDisabled: boolean; // Whether the auth config is disabled
+ isDisabled: boolean; // Whether the auth config is disabled
fields: Record<string, unknown>; // Configuration fields
meta: Record<string, unknown>; // Additional metadata
- createdAt: string; // Creation timestamp
- updatedAt: string; // Last update timestamp
+ createdAt: string; // Creation timestamp
+ updatedAt: string; // Last update timestamp
}
```
@@ -156,9 +158,9 @@ interface AuthConfigRetrieveResponse {
```typescript
interface AuthConfigCreateParams {
- type: AuthConfigType; // Type of auth config
- name: string; // Name of the auth config
- fields?: Record<string, unknown>; // Configuration fields
+ type: AuthConfigType; // Type of auth config
+ name: string; // Name of the auth config
+ fields?: Record<string, unknown>; // Configuration fields
}
```
@@ -166,8 +168,8 @@ interface AuthConfigCreateParams {
```typescript
interface AuthConfigUpdateParams {
- name?: string; // Name of the auth config
- fields?: Record<string, unknown>; // Configuration fields
+ name?: string; // Name of the auth config
+ fields?: Record<string, unknown>; // Configuration fields
}
```
@@ -197,4 +199,4 @@ enum AuthSchemeTypes {
CUSTOM = 'custom',
NO_AUTH = 'no_auth',
}
-```
\ No newline at end of file
+```
diff --git a/packages/core/src/models/AuthConfigs.ts b/packages/core/src/models/AuthConfigs.ts
index e66c80092..e458d77ec 100644
--- a/packages/core/src/models/AuthConfigs.ts
+++ b/packages/core/src/models/AuthConfigs.ts
@@ -107,7 +107,7 @@ export class AuthConfigs {
*
* // List auth configs for a specific toolkit
* const githubConfigs = await composio.authConfigs.list({
- * toolkitSlug: 'github'
+ * toolkit: 'github'
* });
*
* // List Composio-managed auth configs
@@ -122,7 +122,7 @@ export class AuthConfigs {
cursor: parsedQuery?.cursor,
is_composio_managed: parsedQuery?.isComposioManaged,
limit: parsedQuery?.limit?.toString(),
- toolkit_slug: parsedQuery?.toolkitSlug,
+ toolkit_slug: parsedQuery?.toolkit,
});
const parsedResult = AuthConfigListResponseSchema.safeParse({
items: result.items.map(item => this.parseAuthConfigRetrieveResponse(item)),
diff --git a/packages/core/src/types/authConfigs.types.ts b/packages/core/src/types/authConfigs.types.ts
index d0c721d91..8e816c617 100644
--- a/packages/core/src/types/authConfigs.types.ts
+++ b/packages/core/src/types/authConfigs.types.ts
@@ -93,7 +93,7 @@ export const AuthConfigListParamsSchema = z.object({
cursor: z.string().optional(),
isComposioManaged: z.boolean().optional(),
limit: z.number().optional(),
- toolkitSlug: z.string().optional(),
+ toolkit: z.string().optional(),
});
export type AuthConfigListParams = z.infer<typeof AuthConfigListParamsSchema>;