The tutorials in this section demonstrate some common V‑Spark API use cases.

Create and configure analytics applications

Combine /config/apps, /appedit, and /config/folders requests to create an application, upload its configuration, and associate it with a folder.

GET deletion job status with /config

Use /config to retrieve deletion job status.

Manage accounts with /config/users

Use /config/users to retrieve, create, and configure V‑Spark user accounts, to retrieve user account status, to retrieve the authorization method used for login, and to retrieve or configure the permissions that they have in V‑Spark and within each company.

Python scripts

These example scripts were written in Python 2.7. They are included here for example purposes only and should not be used for production environments.

Shell script for transcription and results

This section shows a simple Linux Bash shell script that demonstrates using the /transcribe API to upload a file for transcription, and using the /request to monitor the status of processing that file and retrieve results once transcription has completed.

Use callbacks to receive results

This tutorial shows setting up a simple callback server, submitting audio for transcription with /transcribe, and examining the results, along with suggestions for troubleshooting common problems when setting up and using a callback server.

Use fields to refine /search output

When specifying output=summary in a /search request, use the fields parameter to define the data fields to be included with or excluded from search results.

Using cURL

Use cURL to test the V‑Spark API from the command line. cURL is not required to use the V‑Spark API, but it can be a helpful tool, and is freely available for most operating systems.