JSPM

@speechmatics/batch-client

5.0.0-beta.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17212
  • Score
    100M100P100Q160179F
  • License MIT

Javascript client for the Speechmatics batch jobs API

Package Exports

  • @speechmatics/batch-client
  • @speechmatics/batch-client/dist/index.js
  • @speechmatics/batch-client/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@speechmatics/batch-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Speechmatics batch client 💬

[!WARNING] This package is still in beta. It should be as functional as the legacy package, but some behaviour may have changed.

Official JS client for the Speechmatics batch jobs API.

API documentation can be found here: https://docs.speechmatics.com/jobsapi#tag/jobs

Installation

npm i @speechmatics/batch-client

Usage

More examples will be available soon. For now, you can checkout the NodeJS example.

This package exports a BatchClient class which can be used to call the batch job API endpoints.

API keys 🔑

Note that the apiKey field of the BatchClient may be either a long lived API key, or a short-lived JWT.

If it is a short-lived JWT, the developer is responsible for making sure the key is valid.

You can generate a long-lived API key through our self service portal here: https://portal.speechmatics.com/api-keys

See our documentation about generating short-lived JWTs here: https://docs.speechmatics.com/introduction/authentication