UiPath Documentation
agents
latest
false
Agents user guide

UiPath TypeScript SDK

UiPath TypeScript SDK for integrating chat agent capabilities into custom web applications, portals, and other surfaces.

Overview​

You can build custom interfaces and applications that interact with chat-based conversational agents programmatically using the public UiPath TypeScript SDK. This allows developers to integrate conversational agent capabilities directly into their own web applications, portals, or other custom surfaces.

Intended users: Developers who need to deeply integrate conversational agent interactions into custom-built applications outside of the standard UiPath channels and supported integrations.

Feature availability​

Note:

This headless SDK gives developers access to every conversational agent feature, as represented in the table below. The final experience and features available for the end-user depend on the developer's custom implementation.

FeatureAvailable
Start new chat✅
Chat history✅
Delete chat session✅
User-profile settings✅
Starting prompts✅
File uploads✅
Conversation inputs*✅
Tool-call confirmations✅
Citations✅
HTML preview✅
Copy response✅
Feedback (thumbs)✅

* Since developers have full control over how conversation input values are set on this channel, the SDK enables functionalities such as wiring inputs to web-UI state — or any other client-side state — so the agent receives the latest surface context automatically on every turn. Note that conversation inputs are supported only for Conversational Agents built in Agent Builder.

Getting started​

Refer to the UiPath TypeScript SDK documentation for full API reference, setup instructions, and code examples for integrating conversational agents into your application.

  • Overview​
  • Feature availability​
  • Getting started​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated