V-Spark Online Help

Reference for the /search API

The /search API enables you to search all transcripts for an organization or those that are located in a folder within an organization. You can search using three different REST methods:

GET

Search parameters are specified as query options passed as call parameters

POST

Search parameters are specified as name/value pairs in a JSON file that is passed to the API

DELETE

Transcript ID is specified as a query option passed as a call parameter

Synopsis

GET /search/CO_SHORT/ORG_SHORT?token=TOKEN&OPTIONS...
GET /search/CO_SHORT/ORG_SHORT/FOLDER?token=TOKEN&OPTIONS...
POST /search/CO_SHORT/ORG_SHORT?token=TOKEN&OPTIONS...
POST /search/CO_SHORT/ORG_SHORT/FOLDER?token=TOKEN&OPTIONS...

DELETE /search/CO_SHORT/ORG_SHORT?token=TOKEN&terms.tid=TID
DELETE /search/CO_SHORT/ORG_SHORT?token=TOKEN&tid=TID
DELETE /search/CO_SHORT/ORG_SHORT/FOLDER?token=TOKEN&terms.tid=TID
DELETE /search/CO_SHORT/ORG_SHORT/FOLDER?token=TOKEN&tid=TID

DELETE /search/CO_SHORT/ORG_SHORT?tid=TID1,TID2&token=TOKEN&multi=true
DELETE /search/CO_SHORT/ORG_SHORT/FOLDER?terms.tid=TID1,TID2&token=TOKEN&multi=true
DELETE /search/CO_SHORT/ORG_SHORT/FOLDER?terms.tid=TID1,TID2&token=TOKEN&multi=true
DELETE /search/CO_SHORT/ORG_SHORT/FOLDER?tid=TID1,TID2&token=TOKEN&multi=true

Description

The V‑Spark/search API supports GET, POST, and DELETE calls, all of which search a specified V‑Spark installation, but which pass parameters to the API in different ways. See Using the /search API with cURL for examples of passing parameters using the cURL command. See Using the /search API with Python for examples of using the GET and POST models in Python.

Variables used in a call to the /search API are the following:

CO_SHORT

The short name of the company whose transcripts you want to search

ORG_SHORT

The short name of the organization whose transcripts you want to search. Finding that information is shown in /transcribe API Reference.

FOLDER

The name of the folder whose transcripts you want to search

TOKEN

The V‑Spark authorization token that you are using to establish permission to retrieve information. You can either use the root token for the target V‑Spark installation (located in the file /opt/voci/state/vspark/apitoken) or the authorization token for the company under which the specified ORG_SHORT or FOLDERNAME is located. Locating a company's authorization token is shown in V‑Spark API Permission Requirements.

TID or TID1,TID2,...

The transcriptID of the file or files to be deleted. The parameters tid and terms.tid are equivalent. The multi=true parameter must be specified when deleting multiple files with one call, or the request will return a 400 error.

Subsequent sections provide detailed information about the many GET options (which map to POST name/value pairs) that you can specify in calls to the /search API. Options are discussed in the form that they would be specified as part of a GET call. The value that you specify for the output option determines what other sets of options you can specify.

Content Types

  • GET method options are expected as query parameters with the "text/html" MIME type

  • POST method options are expected as JSON objects with the "application/json" MIME type

  • DELETE method options are expected as query parameters with the "text/html" MIME type

  • count output type returns plain text data with the "text/html" MIME type

  • summary output type with json option returns JSON-formatted data with the "text/html" MIME type

  • summary output type with csv option returns comma separated values with the "text/html" MIME type

  • details output type returns JSON-formatted data with the "text/html" MIME type

  • zip output type returns a zip file with the "application/zip" MIME type

  • Errors will be returned with the "text/html" MIME type