Class: PluginCatalog

Manages the global plugin catalog and annotations (not project-scoped).

Constructors

new PluginCatalog()

new PluginCatalog(ctx): PluginCatalog

Internal

Parameters

Parameter	Type
ctx	ClientContext

Returns

PluginCatalog

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:23

Methods

get()

get(slug): Promise<object>

Get a plugin by slug

Parameters

Parameter	Type	Description
slug	string	Plugin slug (e.g. "profanity-filter")

Returns

Promise<object>

Plugin details

Name	Type	Description	Defined in
category	"moderation" | "analytics" | "automation" | "integration"	Description Category	4Players/cortex-typescript-sdk/src/types.ts:2454
description?	string	Description Description	4Players/cortex-typescript-sdk/src/types.ts:2444
events	string[]	Description Event patterns Example [ "message.created" ]	4Players/cortex-typescript-sdk/src/types.ts:2461
icon?	string	Description Heroicons icon name Example heroicons_outline:shield-check	4Players/cortex-typescript-sdk/src/types.ts:2483
id	string	Description Plugin UUID	4Players/cortex-typescript-sdk/src/types.ts:2432
isActive	boolean	Description Whether plugin is available	4Players/cortex-typescript-sdk/src/types.ts:2485
name	string	Description Display name Example Profanity Filter	4Players/cortex-typescript-sdk/src/types.ts:2442
outputAnnotationType?	"profanity" | "summary" | "action_items" | "sentiment"	Description Output annotation type	4Players/cortex-typescript-sdk/src/types.ts:2466
pricingUrl?	string	Description Pricing page URL for the tied Payment product, shown in the install cost-acceptance notice. Example https://odin.4players.io/pricing	4Players/cortex-typescript-sdk/src/types.ts:2478
productSlug?	string	Description Payment product slug this plugin activates (set = paid plugin). When present, installing/enabling the plugin activates this product and disabling/uninstalling deactivates it. Example amanda	4Players/cortex-typescript-sdk/src/types.ts:2473
settingsSchema?	object[]	Description Settings schema	4Players/cortex-typescript-sdk/src/types.ts:2468
slug	string	Description URL-friendly identifier Example profanity-filter	4Players/cortex-typescript-sdk/src/types.ts:2437
version	string	Description Semantic version Example 1.0.0	4Players/cortex-typescript-sdk/src/types.ts:2449

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:40

---

getMessageAnnotationsBatch()

getMessageAnnotationsBatch(messageIds): Promise<Record<string, object[]>>

Batch retrieve annotations for multiple messages

Parameters

Parameter	Type	Description
messageIds	string[]	Array of message IDs

Returns

Promise<Record<string, object[]>>

Annotations grouped by message ID

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:67

---

getSessionAnnotations()

getSessionAnnotations(sessionId): Promise<object[]>

Get annotations for a session

Parameters

Parameter	Type	Description
sessionId	string	Session ID

Returns

Promise<object[]>

Array of session annotations

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:53

---

list()

list(): Promise<object[]>

List all available plugins in the catalog

Returns

Promise<object[]>

Array of plugins

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:29