http/dist

Interfaces

ChannelEventShortcutEnvelope

Extends

• Omit\<Partial\<ChannelEventEnvelopeInput\<TPayload, TRawPayload>>, "actor">

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

agentId?

optional agentId?: string;

attachments?

optional attachments?: unknown[];

body?

optional body?: string;

channel?

optional channel?: ConversationChannelInput;

Inherited from

Omit.channel

conversationId?

optional conversationId?: string;

dedupeKey?

optional dedupeKey?: string;

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

Omit.direction

id?

optional id?: string;

Inherited from

Omit.id

idempotencyKey?

optional idempotencyKey?: string;

identity?

optional identity?: ChannelEventIdentity;

Overrides

Omit.identity

identityKey?

optional identityKey?: string;

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

identityStreamId?

optional identityStreamId?: string;

intent?

optional intent?: ChannelEventIntent;

Inherited from

Omit.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

Omit.kind

message?

optional message?: string;

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

Omit.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

Omit.nature

occurredAt?

optional occurredAt?: string;

Inherited from

Omit.occurredAt

payload?

optional payload?: TPayload;

Inherited from

Omit.payload

providerObject?

optional providerObject?: unknown;

raw?

optional raw?: TRawPayload;

sequence?

optional sequence?: string | number;

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

Omit.source

status?

optional status?: string;

subject?

optional subject?: string;

summary?

optional summary?: string;

text?

optional text?: string;

turn?

optional turn?: unknown;

---

ChannelEventSubmitInput

Extends

• Omit\<HandleChannelEventInput\<TPayload, TTurn>, "event">

Extended by

• ChannelHandoffEventInput
• ChannelHandoffReviewEventInput
• ChannelMessageEventInput
• ChannelOutputResolutionEventInput
• OutboundContactChannelEventInput
• ProviderObjectChannelEventInput
• ScheduledChannelEventInput
• VoiceTurnChannelEventInput

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

agentId?

optional agentId?: string;

Inherited from

Omit.agentId

app?

optional app?: unknown;

Inherited from

Omit.app

attachments?

optional attachments?: unknown[];

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

Omit.binding

body?

optional body?: string;

channel?

optional channel?: ConversationChannelInput;

conversationContext?

optional conversationContext?: unknown;

Inherited from

Omit.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

Omit.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

Omit.createConversation

dedupeKey?

optional dedupeKey?: string;

deliveryId?

optional deliveryId?: string;

direction?

optional direction?: "outbound" | "inbound" | "internal";

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

eventId?

optional eventId?: string;

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

Omit.handling

id?

optional id?: string;

idempotencyKey?

optional idempotencyKey?: string;

identity?

optional identity?: ChannelEventIdentity;

identityKey?

optional identityKey?: string;

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

identityStreamId?

optional identityStreamId?: string;

intent?

optional intent?: ChannelEventIntent;

kind?

optional kind?: ChannelEventNature;

message?

optional message?: string;

metadata?

optional metadata?: Record<string, unknown>;

nature?

optional nature?: ChannelEventNature;

occurredAt?

optional occurredAt?: string;

payload?

optional payload?: TPayload;

provider?

optional provider?: string;

providerObject?

optional providerObject?: unknown;

providerPackageId?

optional providerPackageId?: string;

raw?

optional raw?: TRawPayload;

receivedAt?

optional receivedAt?: string;

sequence?

optional sequence?: string | number;

signal?

optional signal?: AbortSignal;

Inherited from

Omit.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

sourceId?

optional sourceId?: string;

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

status?

optional status?: string;

streamId?

optional streamId?: string;

subject?

optional subject?: string;

summary?

optional summary?: string;

text?

optional text?: string;

turn?

optional turn?: TTurn;

verified?

optional verified?: boolean;

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

Omit.onAssistantTextDelta

---

ChannelHandoffEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

fromChannel?

optional fromChannel?: ConversationChannelInput;

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

reason?

optional reason?: string;

reasonCode?

optional reasonCode?: string;

reasonLabel?

optional reasonLabel?: string;

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

ChannelHandoffReviewEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

ChannelMessageEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound";

Overrides

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text

text: string;

Overrides

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

ChannelOutputResolutionEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

CognideskHttpAuthorizeInput

Properties

path

path: string;

Request path after the configured basePath has been stripped.

request

request: Request;

Original request before the HTTP handler reads the body or calls the runtime.

url

url: URL;

Parsed request URL.

---

CognideskHttpCorsOptions

Properties

allowedHeaders?

optional allowedHeaders?: string | readonly string[];

Defaults to content-type and authorization.

credentials?

optional credentials?: boolean;

exposedHeaders?

optional exposedHeaders?: string | readonly string[];

maxAgeSeconds?

optional maxAgeSeconds?: number;

methods?

optional methods?: string | readonly string[];

Defaults to GET, POST, and OPTIONS.

origins

origins: string | readonly string[];

Exact browser origins allowed to call the handler, for example "https://app.example.com".

---

CognideskHttpHandler

Methods

handle()

handle(request): Promise<Response>;

Parameters

Parameter	Type
request	Request

Returns

Promise\<Response>

---

CognideskHttpHandlerOptions

Properties

agentId?

optional agentId?: string;

authorize?

optional authorize?: CognideskHttpAuthorize;

Authorize non-preflight requests before the runtime is called. Return true to allow, false for a default 401, or a Response for a custom denial.

basePath?

optional basePath?: string;

cors?

optional cors?: CognideskHttpCorsConfig;

Enable CORS. true keeps the legacy wildcard behavior; prefer an object with explicit origins for browser-facing deployments.

customEvents?

optional customEvents?: CustomRuntimeEventDefinition<string, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>[];

exposeInternalErrors?

optional exposeInternalErrors?: boolean;

Include raw thrown Error messages in 500 responses. Defaults to false so internal runtime details are not exposed to HTTP clients.

journeyEvents?

optional journeyEvents?: JourneyEventDefinition<string, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>[];

runtime

runtime:
  | CognideskRuntime
  | CognideskHttpRuntime;

ssePollIntervalMs?

optional ssePollIntervalMs?: number;

voice?

optional voice?: VoiceSocketHandshake;

---

CognideskHttpRuntime

Methods

closeConversation()?

optional closeConversation(conversationId, reason?): Promise<ConversationRecord<unknown>>;

Parameters

Parameter	Type
conversationId	string
reason?	string

Returns

Promise\<ConversationRecord\<unknown>>

compactConversation()?

optional compactConversation(input): Promise<CompactConversationResult<unknown>>;

Parameters

Parameter	Type
input	CompactConversationInput

Returns

Promise\<CompactConversationResult\<unknown>>

createConversation()

createConversation(input): Promise<ConversationRecord<unknown>>;

Parameters

Parameter	Type
input	CreateRuntimeConversationInput

Returns

Promise\<ConversationRecord\<unknown>>

emitCustomEvent()?

optional emitCustomEvent(input): Promise<RuntimeEvent>;

Parameters

Parameter	Type
input	{ conversationId: string; event: CustomRuntimeEventDefinition; payload: unknown; }
input.conversationId	string
input.event	CustomRuntimeEventDefinition
input.payload	unknown

Returns

Promise\<RuntimeEvent>

emitGeneratedPreamble()?

optional emitGeneratedPreamble(input): Promise<{
  events: RuntimeEvent[];
  text: string;
}>;

Parameters

Parameter	Type
input	EmitGeneratedPreambleInput

Returns

Promise\<{ events: RuntimeEvent[]; text: string; }>

emitIntermediateMessage()?

optional emitIntermediateMessage(input): Promise<{
  events: RuntimeEvent[];
}>;

Parameters

Parameter	Type
input	EmitIntermediateMessageInput

Returns

Promise\<{ events: RuntimeEvent[]; }>

emitJourneyEvent()?

optional emitJourneyEvent(input): Promise<EmitJourneyEventResult>;

Parameters

Parameter	Type
input	{ app?: unknown; conversationId: string; event: JourneyEventDefinition; payload: unknown; routing?: "none" | "activeJourneyOnly" | "full" | "targeted"; signal?: AbortSignal; target?: { journeyId?: string; stateId?: string; }; }
input.app?	unknown
input.conversationId	string
input.event	JourneyEventDefinition
input.payload	unknown
input.routing?	"none" | "activeJourneyOnly" | "full" | "targeted"
input.signal?	AbortSignal
input.target?	{ journeyId?: string; stateId?: string; }
input.target.journeyId?	string
input.target.stateId?	string

Returns

Promise\<EmitJourneyEventResult>

getSnapshot()?

optional getSnapshot(conversationId): Promise<RuntimeSnapshot>;

Parameters

Parameter	Type
conversationId	string

Returns

Promise\<RuntimeSnapshot>

handleChannelEvent()?

optional handleChannelEvent(input): Promise<HandleChannelEventResult<unknown>>;

Parameters

Parameter	Type
input	HandleChannelEventInput

Returns

Promise\<HandleChannelEventResult\<unknown>>

handleUserMessage()

handleUserMessage(input): Promise<HandleUserMessageResult>;

Parameters

Parameter	Type
input	HandleUserMessageInput

Returns

Promise\<HandleUserMessageResult>

listConversations()?

optional listConversations(input?): Promise<ConversationRecord<unknown>[]>;

Parameters

Parameter	Type
input?	ListRuntimeConversationsOptions

Returns

Promise\<ConversationRecord\<unknown>[]>

listEvents()

listEvents(conversationId, afterOffset?): Promise<RuntimeEvent[]>;

Parameters

Parameter	Type
conversationId	string
afterOffset?	number

Returns

Promise\<RuntimeEvent[]>

replayConversation()?

optional replayConversation(input): Promise<ReplayConversationResult>;

Parameters

Parameter	Type
input	ReplayConversationInput

Returns

Promise\<ReplayConversationResult>

requestHandoff()?

optional requestHandoff(input): Promise<{
  conversation: ConversationRecord;
  event: RuntimeEvent;
}>;

Parameters

Parameter	Type
input	RequestHandoffInput

Returns

Promise\<{ conversation: ConversationRecord; event: RuntimeEvent; }>

resolveChannelOutput()?

optional resolveChannelOutput(input): Promise<ResolveChannelOutputResult<unknown>>;

Parameters

Parameter	Type
input	ResolveChannelOutputInput

Returns

Promise\<ResolveChannelOutputResult\<unknown>>

resumeConversation()?

optional resumeConversation(input): Promise<{
  conversation: ConversationRecord;
  event: RuntimeEvent;
}>;

Parameters

Parameter	Type
input	ResumeConversationInput

Returns

Promise\<{ conversation: ConversationRecord; event: RuntimeEvent; }>

startVoiceConversation()?

optional startVoiceConversation(input): Promise<StartVoiceResult>;

Parameters

Parameter	Type
input	StartVoiceConversationInput

Returns

Promise\<StartVoiceResult>

startVoiceSegment()?

optional startVoiceSegment(input): Promise<StartVoiceResult>;

Parameters

Parameter	Type
input	StartVoiceSegmentInput

Returns

Promise\<StartVoiceResult>

submitWidget()?

optional submitWidget(input): Promise<RuntimeEvent>;

Parameters

Parameter	Type
input	SubmitWidgetInput

Returns

Promise\<RuntimeEvent>

---

OutboundContactChannelEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

ProviderObjectChannelEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

ScheduledChannelEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel

channel: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Inherited from

ChannelEventSubmitInput.text

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

---

VoiceTurnChannelEventInput

Extends

• ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Properties

actor?

optional actor?: ChannelEventActorInput;

Inherited from

ChannelEventSubmitInput.actor

agentId?

optional agentId?: string;

Inherited from

ChannelEventSubmitInput.agentId

app?

optional app?: unknown;

Inherited from

ChannelEventSubmitInput.app

attachments?

optional attachments?: unknown[];

Inherited from

ChannelEventSubmitInput.attachments

binding?

optional binding?: ChannelEventBindingInput;

Inherited from

ChannelEventSubmitInput.binding

body?

optional body?: string;

Inherited from

ChannelEventSubmitInput.body

channel?

optional channel?: ConversationChannelInput;

Overrides

ChannelEventSubmitInput.channel

conversationContext?

optional conversationContext?: unknown;

Inherited from

ChannelEventSubmitInput.conversationContext

conversationId?

optional conversationId?: string;

Inherited from

ChannelEventSubmitInput.conversationId

createConversation?

optional createConversation?: CreateRuntimeConversationInput;

Inherited from

ChannelEventSubmitInput.createConversation

dedupeKey?

optional dedupeKey?: string;

Inherited from

ChannelEventSubmitInput.dedupeKey

deliveryId?

optional deliveryId?: string;

Inherited from

ChannelEventSubmitInput.deliveryId

direction?

optional direction?: "outbound" | "inbound" | "internal";

Inherited from

ChannelEventSubmitInput.direction

event?

optional event?: ChannelEventShortcutEnvelope<TPayload, TRawPayload>;

Inherited from

ChannelEventSubmitInput.event

eventId?

optional eventId?: string;

Inherited from

ChannelEventSubmitInput.eventId

externalObjectIds?

optional externalObjectIds?: Record<string, string>;

Inherited from

ChannelEventSubmitInput.externalObjectIds

handling?

optional handling?: ChannelEventHandlingInput<TTurn>;

Inherited from

ChannelEventSubmitInput.handling

id?

optional id?: string;

Inherited from

ChannelEventSubmitInput.id

idempotencyKey?

optional idempotencyKey?: string;

Inherited from

ChannelEventSubmitInput.idempotencyKey

identity?

optional identity?: ChannelEventIdentity;

Inherited from

ChannelEventSubmitInput.identity

identityKey?

optional identityKey?: string;

Inherited from

ChannelEventSubmitInput.identityKey

identityMetadata?

optional identityMetadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.identityMetadata

identityStreamId?

optional identityStreamId?: string;

Inherited from

ChannelEventSubmitInput.identityStreamId

intent?

optional intent?: ChannelEventIntent;

Inherited from

ChannelEventSubmitInput.intent

kind?

optional kind?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.kind

message?

optional message?: string;

Inherited from

ChannelEventSubmitInput.message

metadata?

optional metadata?: Record<string, unknown>;

Inherited from

ChannelEventSubmitInput.metadata

nature?

optional nature?: ChannelEventNature;

Inherited from

ChannelEventSubmitInput.nature

occurredAt?

optional occurredAt?: string;

Inherited from

ChannelEventSubmitInput.occurredAt

payload?

optional payload?: TPayload;

Inherited from

ChannelEventSubmitInput.payload

provider?

optional provider?: string;

Inherited from

ChannelEventSubmitInput.provider

providerObject?

optional providerObject?: unknown;

Inherited from

ChannelEventSubmitInput.providerObject

providerPackageId?

optional providerPackageId?: string;

Inherited from

ChannelEventSubmitInput.providerPackageId

raw?

optional raw?: TRawPayload;

Inherited from

ChannelEventSubmitInput.raw

receivedAt?

optional receivedAt?: string;

Inherited from

ChannelEventSubmitInput.receivedAt

sequence?

optional sequence?: string | number;

Inherited from

ChannelEventSubmitInput.sequence

signal?

optional signal?: AbortSignal;

Inherited from

ChannelEventSubmitInput.signal

source?

optional source?: ChannelEventSourceEvidence<TRawPayload>;

Inherited from

ChannelEventSubmitInput.source

sourceId?

optional sourceId?: string;

Inherited from

ChannelEventSubmitInput.sourceId

sourceType?

optional sourceType?:
  | "application"
  | "provider-adapter"
  | "schedule-adapter"
  | "operator-surface";

Inherited from

ChannelEventSubmitInput.sourceType

status?

optional status?: string;

Inherited from

ChannelEventSubmitInput.status

streamId?

optional streamId?: string;

Inherited from

ChannelEventSubmitInput.streamId

subject?

optional subject?: string;

Inherited from

ChannelEventSubmitInput.subject

summary?

optional summary?: string;

Inherited from

ChannelEventSubmitInput.summary

text?

optional text?: string;

Overrides

ChannelEventSubmitInput.text

transcript?

optional transcript?: string;

turn?

optional turn?: TTurn;

Inherited from

ChannelEventSubmitInput.turn

verified?

optional verified?: boolean;

Inherited from

ChannelEventSubmitInput.verified

Methods

onAssistantTextDelta()?

optional onAssistantTextDelta(textDelta): void | Promise<void>;

Parameters

Parameter	Type
textDelta	string

Returns

void | Promise\<void>

Inherited from

ChannelEventSubmitInput.onAssistantTextDelta

Type Aliases

ChannelEventActorInput

type ChannelEventActorInput =
  | ChannelEventActor
  | ChannelEventActorType;

---

ChannelEventRequestBody

type ChannelEventRequestBody<TPayload, TTurn> = Omit<HandleChannelEventInput<TPayload, TTurn>, "signal" | "onAssistantTextDelta">;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TTurn	unknown

---

CognideskHttpAuthorize

type CognideskHttpAuthorize = (input) =>
  | CognideskHttpAuthorizeResult
| Promise<CognideskHttpAuthorizeResult>;

Parameters

Parameter	Type
input	CognideskHttpAuthorizeInput

Returns

| CognideskHttpAuthorizeResult | Promise\<CognideskHttpAuthorizeResult>

---

CognideskHttpAuthorizeResult

type CognideskHttpAuthorizeResult = boolean | Response;

---

CognideskHttpCorsConfig

type CognideskHttpCorsConfig = boolean | CognideskHttpCorsOptions;

---

CreateChannelEventBody

type CreateChannelEventBody = ChannelEventSubmitInput;

---

ResolveChannelOutputBody

type ResolveChannelOutputBody<TPayload> = Omit<ResolveChannelOutputInput<TPayload>, "signal">;

Type Parameters

Type Parameter	Default type
TPayload	unknown

Functions

createChannelEventInput()

function createChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createChannelEventRequestBody()

function createChannelEventRequestBody<TPayload, TRawPayload, TTurn>(input): ChannelEventRequestBody<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelEventSubmitInput\<TPayload, TRawPayload, TTurn>

Returns

ChannelEventRequestBody\<TPayload, TTurn>

---

createChannelHandoffEventInput()

function createChannelHandoffEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelHandoffEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createChannelHandoffReviewEventInput()

function createChannelHandoffReviewEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelHandoffReviewEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createChannelOutputResolutionEventInput()

function createChannelOutputResolutionEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelOutputResolutionEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createCognideskHttpHandler()

function createCognideskHttpHandler(options): CognideskHttpHandler;

Parameters

Parameter	Type
options	CognideskHttpHandlerOptions

Returns

CognideskHttpHandler

---

createMessageChannelEventInput()

function createMessageChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ChannelMessageEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createOutboundContactChannelEventInput()

function createOutboundContactChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	OutboundContactChannelEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createProviderObjectChannelEventInput()

function createProviderObjectChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ProviderObjectChannelEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createScheduledChannelEventInput()

function createScheduledChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	ScheduledChannelEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

---

createVoiceTurnChannelEventInput()

function createVoiceTurnChannelEventInput<TPayload, TRawPayload, TTurn>(input): HandleChannelEventInput<TPayload, TTurn>;

Type Parameters

Type Parameter	Default type
TPayload	NormalizedChannelPayloadInput
TRawPayload	unknown
TTurn	unknown

Parameters

Parameter	Type
input	VoiceTurnChannelEventInput\<TPayload, TRawPayload, TTurn>

Returns

HandleChannelEventInput\<TPayload, TTurn>

References

ChannelEventActor

Re-exports ChannelEventActor

---

ChannelEventActorType

Re-exports ChannelEventActorType

---

ChannelEventBindingOutcome

Re-exports ChannelEventBindingOutcome

---

ChannelEventDirection

Re-exports ChannelEventDirection

---

ChannelEventEnvelope

Re-exports ChannelEventEnvelope

---

ChannelEventEnvelopeInput

Re-exports ChannelEventEnvelopeInput

---

ChannelEventHandlingDisposition

Re-exports ChannelEventHandlingDisposition

---

ChannelEventIdentity

Re-exports ChannelEventIdentity

---

ChannelEventIntakeResult

Re-exports ChannelEventIntakeResult

---

ChannelEventIntakeStatus

Re-exports ChannelEventIntakeStatus

---

ChannelEventIntent

Re-exports ChannelEventIntent

---

ChannelEventKind

Re-exports ChannelEventKind

---

ChannelEventNature

Re-exports ChannelEventNature

---

ChannelEventSourceEvidence

Re-exports ChannelEventSourceEvidence

---

ChannelEventSourceType

Re-exports ChannelEventSourceType

---

ChannelOutputDeliveryMode

Re-exports ChannelOutputDeliveryMode

---

ChannelOutputIntent

Re-exports ChannelOutputIntent

---

ChannelOutputIntentInput

Re-exports ChannelOutputIntentInput

---

ChannelOutputIntentKind

Re-exports ChannelOutputIntentKind

---

ChannelOutputResolution

Re-exports ChannelOutputResolution

---

ChannelOutputResolutionDecision

Re-exports ChannelOutputResolutionDecision

---

ChannelOutputResolutionOutcome

Re-exports ChannelOutputResolutionOutcome

---

ChannelOutputResolutionPayload

Re-exports ChannelOutputResolutionPayload

---

ChannelOutputResolutionStatus

Re-exports ChannelOutputResolutionStatus

---

ChannelSourceEvidence

Re-exports ChannelSourceEvidence

---

HandleChannelEventInput

Re-exports HandleChannelEventInput

---

HandleChannelEventResult

Re-exports HandleChannelEventResult

---

NormalizedChannelPayload

Re-exports NormalizedChannelPayload

---

NormalizedChannelPayloadInput

Re-exports NormalizedChannelPayloadInput

---

ResolveChannelOutputInput

Re-exports ResolveChannelOutputInput

---

ResolveChannelOutputResult

Re-exports ResolveChannelOutputResult