Core Cyara API Documentation

How to get started with the Cyara API and reference documentation for both versions of the API (CyaraAPI 3.0 and CyaraAPI 2.5)

  • Introduction

    Cyara’s REST APIs helps you automate the tasks commonly performed as part of your application testing process.  Cyara REST API The Cyara REST API is a collection of software function calls that allow a programmer to perform a variety of Cyara Portal fun...

  • Getting Started with the Cyara API

    Planning Your Integration Before you start using the Cyara API, we recommend planning out which tasks you are looking to perform on your Cyara Portal. This ensures that you find the appropriate API route in our API documentation to perform the function ...

  • Authentication

    The authorization credentials comprise two parts; API key and unique access token. Simply put, all API requests must be accompanied by a combination of API key and your unique access token as authorization credentials. Whether you access the REST APIs u...

  • Using the Cyara 3.0 APIs in Swagger

    We recommend reading through the Getting Started article before you plan your integration. After you have created an integration plan, read the steps below to get started with the Cyara 3.0 API. The Cyara 3.0 API is built to allow integrations to the Cy...

  • Capturing a Call Connection ID Variable from a Cyara Test Case

    Overview Cyara Test Cases can be used in a range of different ways to test IVR applications, in this example, we'll walk through how to use a Cyara Test Case to capture a spoken Call Connection ID from your IVR system. Note: This testing method is best ...

  • How to request CSV instead of JSON via the Cyara 3.0 API

    For specific Cyara 3.0 API Endpoints, you can request a CSV formatted response rather than the default JSON response. This is particularly useful if you intend to use the data returned by the endpoint in other applications such as spreadsheets. The abil...

  • API IDs - Test Cases and Campaigns

    Section I. Introduction In the world of Cyara, everything has a unique ID that never changes. Your account? Unique ID. Your user? Unique ID. Your favorite CX Model? It too has a unique ID. Cyara uses these IDs to distinguish one element on the platform ...