API Reference¶
Hand-written package summaries and generated type references for the main public Cognidesk SDK packages.
Hybrid documentation
Each package reference includes auto-generated type signatures alongside hand-written usage examples. Type signatures are generated from the TypeScript source using TypeDoc.
Packages¶
| Package | Description |
|---|---|
@cognidesk/core |
Runtime, agents, journeys, tools, knowledge, events |
@cognidesk/http |
HTTP + SSE transport adapter |
@cognidesk/model |
Model provider adapters |
@cognidesk/react |
React hooks and chat widget |
@cognidesk/ui |
Prebuilt UI components |
@cognidesk/storage |
Storage adapters |
@cognidesk/otel |
OpenTelemetry instrumentation |
| Split provider packages | External Provider Integrations installed individually, such as @cognidesk/integration-email-gmail, @cognidesk/integration-workplace-slack, and @cognidesk/integration-voice-openai |
@cognidesk/voice-websocket |
Browser-facing Cognidesk Voice WebSocket adapter |
@cognidesk/journey-index-json |
JSON-based journey index |
@cognidesk/test-harness |
Runtime scenario and provider conformance testing |
@cognidesk/studio-contracts |
Shared schemas for Studio target manifests, introspection, dashboards, auth, and operator sessions |
Provider Integrations¶
Provider Integrations for email, messaging, SMS, workplace, social, ticketing, contact center, reviews, marketplace, video, voice provider APIs, and related support surfaces ship as individual @cognidesk/integration-{category}-{provider} packages. OpenAI Realtime voice is available as @cognidesk/integration-voice-openai. They are documented by capability in the Provider Integrations guide.
Generated TypeDoc coverage includes the public declaration exports for the 63 provider package workspaces under integrations/{category}/{provider}. To keep the API navigation readable, provider packages are not listed one by one in the main nav; use the generated module index for type signatures under generated/integrations/... and the Provider Integration Catalog for package-by-package capability, boundary, and evidence summaries.
The generated provider pages document Cognidesk package types and helpers. They are not claims of full external provider API coverage unless the matching Provider Manifest declares that scope.
Additional monorepo packages such as @cognidesk/connections, @cognidesk/evals, and Studio adapter packages support advanced workflows. Their user-facing behavior is documented in the guides while generated reference coverage expands.