Changelog

v2 API release

Ada is releasing a new version (v2) of our platform APIs. For detailed instructions on how to migrate your integrations, please see our Migration Guide.

In addition to an updated developer documentation site, we’re adding the following capabilities to our platform in this release:

API Endpoints Consolidation

Several legacy endpoints have been merged and restructured by resource and action. This makes integrations simpler and reduces redundancy. For example:

• v1: https://example.ada.support/api/end-users/v1/
• v2: https://example.ada.support/api/v2/end-users/

Streamlined API Tokens

A single API token now works across all endpoints. Previously, separate tokens were required per API. This change simplifies token management and authentication.

Uniform Response Structures

Responses (including error messages) are now standardized. This reduces the complexity of handling different response formats and improves overall consistency.

Standardized Pagination

Pagination parameters and response metadata are now consistent, enhancing the developer experience when handling large data sets.

Improved Rate & Data Limits

More transparent rate and data limit policies have been introduced. This ensures better reliability, prevents unexpected throttling, and makes it easier to plan request volumes.

Data Export API Updates

The Data Export API endpoints have been updated to follow the new v2 naming convention:

• /api/data_api/v1.4/conversations → /api/v2/export/conversations
• /api/data_api/v1.4/messages → /api/v2/export/messages

Backward-Incompatible Changes

Some v1 functionality has been deprecated or altered. Review your current integrations and ensure you’re using the appropriate v2 endpoints and parameters.

Embed2 security improvements

We’ve released some security improvements to Embed2.

• If you’re using the Embed2 NPM package , upgrade it to version 1.7.27 or newer.
• The Embed2 script is versionless and gets automatic updates, so if you’re using it, you can already access the upgrades.

setSensitiveMetaFields Embed2 Action now supported in Generative

Previously the setSensitiveMetaFields action in Embed2 action and sensitiveMetaFields setting were only supported in scripted bots, now it is supported in Generative AI Agents.

Embed2 security improvements

We’ve released some security improvements to Embed2.

• If you’re using the Embed2 NPM package , upgrade it to version 1.7.18 or newer.
• The Embed2 script is versionless and gets automatic updates, so if you’re using it, you can already access the upgrades.

New callback events in Embed2

We’ve added three new events to the subscribeEvent action in Embed2. With these events, you can provide your clients with a better experience after a bot or AI Agent has handed the conversation off to a human agent:

If you’re using the Embed2 script, these events are immediately available. If you’re using the NPM package, update it to the latest version (1.7.17) to start using them.

New conversation topic fields

We’ve added multiple fields to the Data Export API’s Conversation object:

• generated_topic_v2_desc
• generated_topic_v2_id
• generated_topic_v2_parent_id
• generated_topic_v2_title

These are to support the enhancements we made to conversation topics, which we released in May 2024. Those enhancements improved the classifications in your AI Agent’s automatic topic classifications, and now you can access that new data via API. The older topics fields, generated_topic_id and generated_topic_label, are still available so you can access information about older conversation topics.

New tags in End User API webhook payloads

When you’re creating or updating users with webhooks in the End User API, you’ll now see tags that you can use to filter webhook events on the Ada dashboard. You can currently use this tag to filter webhook events by End User ID.

Create global keys to use with all of your Ada APIs

Until now, if you’ve used multiple Ada APIs, you’ve had to create and manage different keys for each one. Now, you have the option to create one or more global keys that work across all of Ada’s current and future platform APIs.

All of your existing API-specific keys will continue to work, and will still be specific to the APIs they were originally generated for. They’ll be marked as legacy keys in your dashboard, so you can tell them apart from your global keys.

For more information, see Authorize API integrations.

New fields in the Data Export API

We have added multiple fields to the Data Export API. Click through to each object type to learn more:

• Conversation object
  • agent_handle_time
  • bot_handle_time
  • record_last_updated
• Message object
  • record_last_updated

Add IDs and metadata to sources in the Knowledge API

To make it easier to manage your knowledge base’s sources, you now have the option to add information into external_id and metadata fields when you create or update a knowledge source.