Skip to main content

@dialstack/sdk-dev / js/src / AIAgentHostSubmitPayload

Interface: AIAgentHostSubmitPayload

Defined in: sdk/js/src/types/ai-agent.ts:72

What the AIAgent form hands a host-controlled create or save.

A field hidden with hideFields is left out rather than sent empty, so a host that forwards the payload as a partial update keeps the stored value. faq_responses matters most: the API replaces the whole list whenever it is present, so an empty array would delete every FAQ.

Properties​

extension_number?​

TypeScript
extension_number?: string;

Defined in: sdk/js/src/types/ai-agent.ts:75


faq_responses?​

TypeScript
faq_responses?: FAQItem[];

Defined in: sdk/js/src/types/ai-agent.ts:80

Absent when faq is hidden.


greeting_name?​

TypeScript
greeting_name?: string;

Defined in: sdk/js/src/types/ai-agent.ts:77


instructions?​

TypeScript
instructions?: string;

Defined in: sdk/js/src/types/ai-agent.ts:78


name?​

TypeScript
name?: string;

Defined in: sdk/js/src/types/ai-agent.ts:74

Absent when name is hidden.


persona_name?​

TypeScript
persona_name?: string;

Defined in: sdk/js/src/types/ai-agent.ts:76


scheduling?​

TypeScript
scheduling?: SchedulingConfig;

Defined in: sdk/js/src/types/ai-agent.ts:81