Use the SDK

The SDK is a planned developer wrapper for calling employees from JavaScript, Python, and other supported runtimes. It would make common REST API operations easier while keeping authentication, tenant scoping, and response handling consistent.

TL;DR

The SDK is on the roadmap as a client library over the existing employee REST API. No package is published and there is nothing to install today. Use the REST API guide for current integrations and production work.

How It Works

flowchart LR
  A[Your application] --> B[SDK]
  B --> C[REST API]
  C --> D[Employee]

When released, the SDK would send authenticated requests to the same API documented in the REST guide. It would not create a second execution path or a separate employee memory.

What It Can Do

• Start conversations from an application.
• Read responses and activity using typed helpers.
• Reuse API authentication and error handling patterns.

How to Set It Up

No package is published yet, and there is no setup for it. For current work, create an API key under Settings > Technical > Channels > API, then follow the REST API guide.

Tips & Tricks

Until a client library ships, call the REST API directly. Keep any future SDK credentials server-side, the same way you would keep an API key server-side today.

Good to Know

The SDK card shows Coming soon. The REST API is the supported integration surface today, and every SDK call would ultimately reach the same API.

Frequently Asked Questions

Q: Which languages will be supported?
A: JavaScript and Python are planned first, with more languages possible later.

Q: Does the SDK replace the REST API?
A: No. It would be a convenience layer over the REST API, not a separate system.

Q: Can I use it now?
A: No. Use the REST API guide instead.

Q: Will the SDK add new capabilities the REST API does not have?
A: No. It is planned as a thinner way to call the same endpoints, not a new feature surface.