API Reference · Private Preview
Retell Adapter API Reference
Actions-only Retell adapter types and tool-call handling boundary.
Package-root import
ESM · Node >=22
import * as AnswerUp from '@answerup/retell';Readable API documentation is available now; package installation access begins with the Private Preview.
Public package exports
Consumes bounded Actions results at the adapter boundary. The index below is grouped by authoritative declaration kind.
Functions
createRetellAdapterfunction
export declare function createRetellAdapter(options: { readonly actions: ActionsFacade; readonly trustedContextResolver: Function; readonly invocationStore?: unknown; readonly webhookUrlResolver?: Function }): RetellAdapter;Interfaces
ActionsBoundedResultinterface
export interface ActionsBoundedResult { readonly kind: "COMMITTED" | "DISPROVED" | "UNKNOWN" | "NEEDS_CLARIFICATION" | "DENIED" | "INTEGRATION_FAILURE"; readonly claims?: Readonly<{ readonly safeClaims: readonly Readonly<{ readonly claimType: string }>[] }>; readonly clarification?: unknown; }ActionsFacadeinterface
export interface ActionsFacade { readonly getTools: () => readonly ActionsTool[]; readonly run: (request: Readonly<{ readonly action: string; readonly input: unknown; readonly context: unknown }>) => Promise<ActionsBoundedResult>; readonly reconcile: (result: ActionsBoundedResult) => Promise<ActionsBoundedResult>; }ActionsToolinterface
export interface ActionsTool { readonly name: string; readonly version: string; readonly description?: string; readonly inputSchema?: Readonly<Record<string, unknown>>; }RetellAdapterinterface
export interface RetellAdapter { readonly getTools: (config?: unknown) => readonly Readonly<Record<string, unknown>>[]; readonly handleToolCall: (call: RetellCall, hostContext?: unknown) => Promise<RetellResult>; readonly reconcile: (invocationId: string, hostContext?: unknown) => Promise<RetellResult>; readonly conformance: () => Readonly<{ passed: boolean; checks: Readonly<Record<string, boolean>> }> }RetellCallinterface
export interface RetellCall { readonly callId?: string; readonly call_id?: string; readonly toolCallId?: string; readonly tool_call_id?: string; readonly name?: string; readonly args?: unknown; readonly arguments?: unknown; readonly input?: unknown; readonly [key: string]: unknown; }RetellResultinterface
export interface RetellResult { readonly status: string; readonly safeClaims: readonly Readonly<{ readonly claimType: string }>[]; readonly needsClarification: boolean; readonly needsReconciliation: boolean; readonly messageDirective: string; readonly correlation: Readonly<Record<string, unknown>>; readonly diagnosticCode?: string; }Examples and deeper guidance
The package-root import above is a package-specific, non-executing example. Use the exact declaration surface for signatures and types; semantic parameter descriptions are shown only where established by package authority.
Read the related lifecycle guidance for the package’s documented role. No credentials or external execution are provided here.