Documentation - v1.5.0-beta.6
    Preparing search index...

    Interface StartRequest

    Represents a request to start a new conversation with a Copilot Studio agent. This request encapsulates all parameters needed to initiate a conversation.

    interface StartRequest {
        conversationId?: string;
        emitStartConversationEvent?: boolean;
        locale?: string;
    }
    Index

    Properties

    conversationId? emitStartConversationEvent? locale?

    Properties

    conversationId?: string

    Optional conversation ID to use for this conversation. If not specified, a new conversation ID will be generated by the service.

    emitStartConversationEvent?: boolean

    Whether to emit a start conversation event. When true, the agent will be notified that this is the beginning of a new conversation. Default is true.

    locale?: string

    Optional locale code (e.g., 'en-US', 'fr-FR') for the conversation. If not specified, the agent's default locale will be used.

    Settings

    Member Visibility

    On This Page

    Properties