SessionConfigs

Usage

Access this class through the composio.sessionConfigs property:

const composio = new Composio({ apiKey: 'your-api-key' });
const result = await composio.sessionConfigs.list();

Methods

get()

Retrieve one saved Session config with its description and access policy. A missing or cross-project id surfaces as the backend's 404.

Requires Session configs to be enabled for the project.

async get(id: string, requestOptions?: ComposioRequestOptions): Promise<{ archived: boolean; config: { tags?: { disable?: ... | ... | ... | ...[]; enable?: ... | ... | ... | ...[] }; toolkits?: { enable: ...[] } | { disable: ...[] }; tools?: Record<string, { enable: ... } | { disable: ... } | { tags: ... }> }; createdAt: string; description: string | null; id: string; name: string; updatedAt: string }>

Parameters

Returns

Promise<\{ archived: boolean; config: \{ tags?: \{ disable?: ... \| ... \| ... \| ...[]; enable?: ... \| ... \| ... \| ...[] \}; toolkits?: \{ enable: ...[] \} \| \{ disable: ...[] \}; tools?: Record<string, \{ enable: ... \} \| \{ disable: ... \} \| \{ tags: ... \}> \}; createdAt: string; description: string \| null; id: string; name: string; updatedAt: string \}> — The config and its policy

Example

const sessionConfig = await composio.sessionConfigs.get('sc_abc123');
console.log(sessionConfig.config.toolkits);

list()

List the project's saved Session configs with cursor pagination.

Omitting archived returns active configs; archived: true returns only archived ones. The backend defaults limit to 20 and caps it at 100.

Requires Session configs to be enabled for the project.

async list(params?: { archived?: boolean; cursor?: string; limit?: number; search?: string }, requestOptions?: ComposioRequestOptions): Promise<{ items: { archived: boolean; createdAt: string; id: string; name: string; updatedAt: string }[]; nextCursor: string | null }>

Parameters

Returns

Promise<\{ items: \{ archived: boolean; createdAt: string; id: string; name: string; updatedAt: string \}[]; nextCursor: string \| null \}> — Config summaries and the next cursor

Example

let cursor: string | undefined;
do {
  const page = await composio.sessionConfigs.list({ cursor });
  for (const item of page.items) console.log(item.id, item.name);
  cursor = page.nextCursor ?? undefined;
} while (cursor);