V-Spark Online Help

V‑Spark API Overview

V‑Spark is an all-inclusive speech analysis application that enables you to visualize audio using state-of-the-art speech recognition, transcription, and text analysis technologies. V‑Spark automatically transcribes audio into searchable text, then organizes and archives the data, and finally provides an intuitive web interface through which you can examine and explore that data. The information is stored in a database where the audio can be searched and analyzed for compliance, customer insights, and agent performance. V‑Spark has the most complete set of speech technologies in a single solution on the market today.

This guide explains how to use V‑Spark's Representational State Transfer (REST) Application Programming Interface (API) to:

  • automate the upload of audio and optional metadata into V‑Spark

  • automate the download of fully annotated transcripts out of V‑Spark

  • examine or modify a V‑Spark installation using APIs that enable you to:

    • retrieve, update, delete, or list information about companies, organization, folders, and applications

    • retrieve information about users

    • retrieve status information (in JSON and CSV format) about companies and folders

    • search the files in a folder or under an organization to identify and retrieve matching search results

      • search results can be retrieved in JSON and CSV format, as well as ZIP-format archive files that contain the results

Note that the V‑Spark API is identical for both on-premises and cloud-based deployments. The V‑Spark REST API uses the HyperText Transfer Protocol (HTTP) for data transfers. Every Voci solution includes a REST API to make integration with our products quick and easy in any computer language. A basic level of programming skill is required to use this API.