Endpoints

The values for $host and $port, and the protocol (http or https) used to access the V‑Spark API varies by installation. The default protocol is http. The default port is 3000. Every request requires a valid token.


V‑Spark API endpoint	Usage	HTTP Methods
`http://$host:$port/`appedit	Retrieve and modify category configuration for analytics applications.	GET, POST
`http://$host:$port/`appmatches	Retrieve all of the phrases in a single transcript that matched application categories during analytics processing.	GET
`http://$host:$port/`appstats	Retrieve daily statistics for agent analytics application and category scores.	GET
`http://$host:$port/`config	Create, modify, and delete V‑Spark system settings, companies, organizations, folders, applications, and user accounts.	GET, POST, DELETE
`http://$host:$port/`list	Retrieve name-level information for V‑Spark company, organization, and folder entities, along with applications and user accounts.	GET
`http://$host:$port/`metadata	Modify and delete a transcript's metadata values.	PATCH, DELETE
`http://$host:$port/`request	Retrieve transcription and analytics results.	GET
`http://$host:$port/`search	Search for transcript and audio records.	GET, POST, DELETE
`http://$host:$port/`stats	Retrieve daily statistics for V‑Spark folders.	GET
`http://$host:$port/`status	Retrieve V‑Spark folder and job status.	GET
`http://$host:$port/`sysinfo	Retrieve V‑Spark system status, configuration, and software version.	GET
`http://$host:$port/`transcribe	Submit files to V‑Spark for ASR transcription and text analytics.	POST

Refining requests by entity

Most endpoints accept the names of V‑Spark company, organization, folder, application, or user account entities as path parameters. When refining requests with these entities, note that

If no company short name ($co_short) is included with the request, the response includes all data for every company for which the request's token has read permissions.
If a company short name is included with the request, the JSON response includes only that company's data.
If any entity name is included with the request, the JSON response includes only information associated with the entity or entities in the request path.
If any of these path parameters is invalid, the request returns an error.

Content types

Some request content varies by endpoint. Exceptions are noted in individual endpoint references.


Method	Expects	Returns
POST	application/json multipart/form	text/html
PATCH	application/json	text/html
GET	application/json	text/html application/json
DELETE		text/html
Errors		text/html