MOR API Transcriptions AI

From Kolmisoft Wiki
Jump to navigationJump to search

Documentation

Full MOR REST API Documentation is available in /billing/api/v2/api-docs.

Definition: AI Transcriptions API.

Definition AI Transcriptions API.png

Description

The API is used to send the recording to the remote AI server, and the result is the transcription (voice-to-text).

API

The Transcriptions AI API accepts parameters in JSON format. Responses are also returned in JSON format.

There are 6 endpoints related to Transcriptions AI:

  • GET /usage - Get remaining usage for the current MOR tenant (transcription).
  • POST /transcriptions - Create a transcription job for a MOR recording.
  • GET /transcriptions/{id} - Get transcription job status.
  • DELETE /transcriptions/{id} - Cancel a queued job or discard results if processing.
  • POST /transcriptions/{id}/transcript - Get transcript text and segments stored by MOR.
  • POST /transcriptions/{id}/download/{format} - Download transcript artifact.


Authentication

The Transcriptions AI API requires user authentication - basic authentication (username/password) and JWT token authentication.

Basic authentication

Basic authentication uses the User's username and password to access API endpoints.

Username and password must be provided in HTTP Authorization header, "username:password" string encoded in Base64. For example:

POST http://x.x.x.x/billing/api/v2/authentication/login HTTP/1.1
Authorization: Basic cmljYXJkYxM6OWtBWFpadT9yak1iayRSaA==


JWT authentication

JWT authentication uses a token (generated by MOR) with each request to endpoints. The API client must obtain a JWT token by calling the /authentication/login endpoint and then use this token in other endpoints for authentication until the token expires. The authentication token is valid for 15 minutes. Once the token has expired, a new token must be obtained from /authentication/refresh endpoint. Therefore, you need to run the refresh method every 15 minutes. The refresh token is valid for 7 days.

JWT token must be provided in HTTP Authorization header when requesting endpoints. For example:

GET http://x.x.x.x/billing/api/v2/ai/usage
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3NpZ25lZF9kZXZpY2VzIjoiMiw4LDEwLDEyLDE4LDI2LDM2IiwiZXhwIjoxNzUyNTU1Njk4LCJpYXQiOjE3NTI0NjkyOTgsImlzcyI6IkZsYXNoIENhbGxzIEFQSSIsInN1YiI6InJpY2FyZGFzIn0.I3Sy1zrJx0mAsTLthitY8dyZfythsWzJ4V1CVfNJmYU


Additional notes

After Basic authentication, select Definition: AI Transcriptions API.

Definition AI Transcriptions API.png

Press on Authorize, enter JWT token to MorAuth authorization, and press Authorize to unlock AI methods.

MOR api v2 Definition AI Transcriptions API MorAuth.png

More examples and responses are available in the MOR REST API Documentation, which is available in /billing/api/v2/api-docs.