V-Spark Online Help

/request API Reference

You can receive JSON and text transcripts and audio files directly within V‑Spark or by using the /request API call to retrieve them manually. V‑Spark uses the HTTP POST method to provide transcripts to a callback server. A callback server is a client-side HTTP server that is used to receive information from a known source and process it appropriately. In most cases, using callbacks rather than polling the results of submitting and analyzing audio files for transcription is simpler and more efficient.

Callback URLs are defined as part of V‑Spark folder configuration. In most cases, you will not need to customize the callback URL that is configured when V‑Spark folders are created. You will only want to do so if you want to integrate V‑Spark with external applications (Filesystem, HTTP/S, SFTP), external storage locations for audio data (S3), and so on. Using a callback server with V‑Spark is described in Using Callbacks in V‑Spark, and is the preferred way of interacting with the V‑Spark API.

For situations where a callback server cannot be used and you want to call the V‑Spark API directly, Reference for the /request API provides reference material and examples of using the /request API. It is not necessary to specify a callback URL as part of using the /request API because results are returned directly by the API call, but you must wait until a call to the /request method shows that processing has completed until you can retrieve complete results.


Throughout the remainder of this section, HTTP refers to both of the HTTP and HTTPS protocols.