Copilot Studio Direct Line Chat Node

C

Data/Microsoft/Copilot Studio

Chat with a Copilot Studio agent over Direct Line, for agents without Microsoft authentication (anonymous or manual auth). Uses the token endpoint (Channels → Mobile app) or the Web channel security secret; no Microsoft sign-in. Pass the returned session back in to continue the conversation.

data_microsoft_copilot_studio_direct_line_chatdataLong running

Inputs10

Outputs14

Security exposure8/10

Packagedata

Ratings

Scores range from 0 to 10. Higher values mean more impact, exposure, or operational weight.

SecurityAttack surface and exposure impact.

8/10High

PrivacyPotential sensitivity of processed data.

5/10Medium

PerformanceRuntime or resource pressure.

4/10Medium

GovernancePolicy, audit, or compliance impact.

8/10High

ReliabilityOperational stability considerations.

7/10High

CostExternal or compute cost impact.

3/10Low

Input Pins

10

Input

Execution

exec_in

Trigger

Token Endpoint

String

token_endpoint

The agent's token endpoint from Channels → Mobile app (when secured access is off)

Channel Secret

String

secret

Web channel security secret (when secured access is on); never stored in the session

Sensitive

Region

String

region

Direct Line cluster; Auto asks the agent's environment (needs the token endpoint)

Default Auto

AutoGlobalEuropeIndia

Timeout (s)

Integer

timeout_seconds

How long to wait for the agent's reply

Default 120

Range 5 to 900

Session

Struct

session

Session returned by a previous call; leave unconnected to start a new conversation

SchemaDirectLineSessionDirectLineSessionDirectLineSession6 fields

conversation_idstringrequired

tokenstringrequired

expires_atinteger:uint64required

Unix seconds.

format uint64min 0

watermarkstring | null

default null

endpointstringrequired

`https://{region.}directline.botframework.com/v3/directline`

user_idstringrequired

Prompt

String

prompt

The user's message

User ID

String

user_id

Stable id for the user in this conversation

Default flow-like-user

Locale

String

locale

Language of the conversation, e.g. en-US or de-DE

Default en-US

Run Greeting

Boolean

run_greeting

On a new conversation, run the agent's Conversation Start topic first

Default false

Output Pins

14

On Stream

Execution

on_stream

Fires for every streamed text or progress chunk

Chunk

Struct

chunk

Streamed chunk: answer text as content, progress updates as reasoning

SchemaResponseChunkResponseChunkResponseChunk8 fields

idstringrequired

choicesArray<ResponseChunkChoice>required

itemsResponseChunkChoicearray item

indexinteger:int32required

format int32

deltaanyOf (2)

variant 1Deltavariant

variant 2nullvariant

finish_reasonstring | null

logprobsanyOf (2)

variant 1LogProbsvariant

variant 2nullvariant

createdinteger | null

format uint64min 0

modelstring | null

service_tierstring | null

system_fingerprintstring | null

usageanyOf (2)

variant 1Usagevariant

completion_tokensinteger:uint32required

format uint32min 0

prompt_tokensinteger:uint32required

format uint32min 0

total_tokensinteger:uint32required

format uint32min 0

costnumber | null

format double

prompt_tokens_detailsanyOf (2)

variant 1PromptTokenDetailsvariant

variant 2nullvariant

+2 more fields

variant 2nullvariant

x_prefill_progressnumber | null

format float

Schema enforced

Done

Execution

done

The agent finished its turn

Error

Execution

error

The call failed

Result

Struct

result

The agent's reply with citations as annotations

SchemaResponseResponseResponse8 fields

idstring | null

choicesArray<Choice>required

itemsChoicearray item

indexinteger:int32required

format int32

finish_reasonstringrequired

messageResponseMessagerequired

rolestringrequired

contentstring | null

content_partsArray<Content>

Ordered structured content returned by Rig when the assistant response contains media. Text-only responses continue to use `content` alone for OpenAI compatibility.

refusalstring | null

annotationsarray | null

+3 more fields

logprobsanyOf (2)

variant 1LogProbsvariant

variant 2nullvariant

createdinteger | null

format uint64min 0

modelstring | null

service_tierstring | null

system_fingerprintstring | null

objectstring | null

usageUsagerequired

completion_tokensinteger:uint32required

format uint32min 0

prompt_tokensinteger:uint32required

format uint32min 0

total_tokensinteger:uint32required

format uint32min 0

costnumber | null

format double

prompt_tokens_detailsanyOf (2)

variant 1PromptTokenDetailsvariant

cached_tokensinteger | null

format uint32min 0

audio_tokensinteger | null

format uint32min 0

variant 2nullvariant

+2 more fields

Schema enforced

Conversation ID

String

new_conversation_id

Pass this into the next call to continue the conversation

Suggested Actions

String Array

suggested_actions

Quick replies the agent offered; send one back as the next message

Cards

Struct Array

cards

Adaptive Cards and other attachments the agent sent

SchemaCopilotStudioAttachmentCopilotStudioAttachmentCopilotStudioAttachment4 fields

content_typestringrequired

namestring | null

content_urlstring | null

contentvalue

default null

Attachments

Struct Array

attachments

Citations from generative answers, as chat attachments

SchemaAttachmentAttachmentAttachment2 fields

variant 1stringvariant

variant 2ComplexAttachmentvariant

urlstringrequired

preview_textstring | null

thumbnail_urlstring | null

namestring | null

sizeinteger | null

format uint64min 0

+3 more fields

Expecting Input

Boolean

expecting_input

The agent asked a question and waits for the user's answer

Conversation Ended

Boolean

conversation_ended

The agent ended the conversation; start a new one for the next message

Activities

Struct Array

activities

Every raw Bot Framework activity received in this call

SchemaBotActivityBotActivityBotActivity4 fields

typestring

default ""

idstring | null

namestring | null

textstring | null

Error Message

String

error_message

Why the call failed

Session

Struct

new_session

Pass this into the next call to continue the conversation

SchemaDirectLineSessionDirectLineSessionDirectLineSession6 fields

conversation_idstringrequired

tokenstringrequired

expires_atinteger:uint64required

Unix seconds.

format uint64min 0

watermarkstring | null

default null

endpointstringrequired

`https://{region.}directline.botframework.com/v3/directline`

user_idstringrequired

Schema enforced

Node Info

Internal name

data_microsoft_copilot_studio_direct_line_chat

Category

Data/Microsoft/Copilot Studio