@hahnpro/hpc-api 2026.8.7 → 2026.9.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @hahnpro/hpc-api
 
+# 2026.9.1
+
+- Added `transcribeAudio` (`POST /ai/audio/transcription`) for server-side audio transcription and removed `getSpeechToken` (`GET /ai/speech/token`)
+
 # 2026.8.5
 
 - added `MostRecentTimeSeriesValueUpdate` and `WebSocketError` types to interfaces

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2026.8.7",
+  "version": "2026.9.1",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {

package/src/lib/interfaces/ai.interface.d.ts

@@ -247,9 +247,8 @@ export interface UserMessage extends BaseMessage {
     attachments?: MessageAttachment[];
 }
 export type Message = AssistantMessage | SystemMessage | ToolMessage | UserMessage | ErrorMessage;
-export interface SpeechToken {
-    token: string;
-    region: string;
+export interface AudioTranscription {
+    text: string;
 }
 export interface Thread {
     id: string;

package/src/lib/interfaces/index.d.ts

@@ -1,4 +1,4 @@
-export type { AiAssistant, AiSkill, AiSkillSummary, AssetResourceSelectionOption, AssistantMessage, DocumentResourceSelectionOption, ErrorMessage, GenericResourceSelectionOption, LogbookEntryResourceSelectionOption, Message, MessageAttachment, OneShotTaskResult, ResourceSelectionOption, ResourceSelectionRejected, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, ToolNameType, UserMessage, } from './ai.interface';
+export type { AiAssistant, AiSkill, AiSkillSummary, AudioTranscription, AssetResourceSelectionOption, AssistantMessage, DocumentResourceSelectionOption, ErrorMessage, GenericResourceSelectionOption, LogbookEntryResourceSelectionOption, Message, MessageAttachment, OneShotTaskResult, ResourceSelectionOption, ResourceSelectionRejected, SystemMessage, Thread, ThreadPopulated, ToolMessage, ToolNameType, UserMessage, } from './ai.interface';
 export type { Alert, AlertCondition, TimeSeriesReference, UpdatedField } from './alert.interface';
 export type { Api, Change, ChangeSubject, ObjectIdLike } from './api.interface';
 export type { AddToProperty, Asset, AssetChange, AssetRevision, AssetSubject, AssetTimeSeriesValue, AssetType, AssetTypeRevision, AssetTypeSearchResult, Attachment, EventCause, EventLevelOverride, RemoveFromProperty, Template, } from './asset.interface';

package/src/lib/mock/ai.mock.service.d.ts

@@ -1,4 +1,4 @@
-import { AiAssistant, AiSkill, AiSkillSummary, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, SpeechToken, Thread, ThreadPopulated, TokenOption } from '../interfaces';
+import { AiAssistant, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, Thread, ThreadPopulated, TokenOption } from '../interfaces';
 import { AiService } from '../services';
 import type { CrossPlatformFormData } from '../utils';
 import { APIBaseMock } from './api-base.mock';
@@ -9,7 +9,7 @@ export declare class AiMockService extends APIBaseMock<never> implements AiServi
     getLatestAssistantThread(assistantId: string): Promise<ThreadPopulated>;
     getAssistant(assistantId: string): Promise<AiAssistant>;
     getAssistants(options?: TokenOption): Promise<AiAssistant[]>;
-    getSpeechToken(): Promise<SpeechToken>;
+    transcribeAudio(_form: CrossPlatformFormData, _options?: Config): Promise<AudioTranscription>;
     getSkills(_options?: Config): Promise<AiSkillSummary[]>;
     setSkillEnabled(_id: string, _enabled: boolean, _options?: Config): Promise<AiSkill>;
     deleteSkill(_id: string, _options?: Config): Promise<AiSkill>;

package/src/lib/mock/ai.mock.service.js

@@ -21,7 +21,7 @@ class AiMockService extends api_base_mock_1.APIBaseMock {
     getAssistants(options = {}) {
         throw new Error('Method not implemented.');
     }
-    getSpeechToken() {
+    transcribeAudio(_form, _options = {}) {
         throw new Error('Method not implemented.');
     }
     getSkills(_options = {}) {

package/src/lib/services/ai.service.d.ts

@@ -1,5 +1,5 @@
 import { APIBase } from '../api-base';
-import { AiAssistant, AiAssistantId, AiSkill, AiSkillSummary, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, SpeechToken, Thread, ThreadPopulated, TokenOption } from '../interfaces';
+import { AiAssistant, AiAssistantId, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, Thread, ThreadPopulated, TokenOption } from '../interfaces';
 import { CrossPlatformFormData } from '../utils';
 import { HttpClientService } from './http-client.service';
 export declare class AiService extends APIBase {
@@ -10,7 +10,7 @@ export declare class AiService extends APIBase {
     listAssistantThreads(assistantId: AiAssistantId): Promise<ThreadPopulated[]>;
     getAssistant(assistantId: AiAssistantId): Promise<AiAssistant>;
     getAssistants(options?: TokenOption): Promise<AiAssistant[]>;
-    getSpeechToken(): Promise<SpeechToken>;
+    transcribeAudio(form: CrossPlatformFormData, options?: Config): Promise<AudioTranscription>;
     getSkills(options?: Config): Promise<AiSkillSummary[]>;
     setSkillEnabled(id: string, enabled: boolean, options?: Config): Promise<AiSkill>;
     deleteSkill(id: string, options?: Config): Promise<AiSkill>;

package/src/lib/services/ai.service.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiService = void 0;
 const api_base_1 = require("../api-base");
 const utils_1 = require("../utils");
+const AUDIO_TRANSCRIPTION_TIMEOUT_MS = 5 * 60000;
 class AiService extends api_base_1.APIBase {
     constructor(httpClient) {
         super(httpClient, '/ai');
@@ -25,8 +26,15 @@ class AiService extends api_base_1.APIBase {
     getAssistants(options = {}) {
         return this.httpClient.get(`${this.basePath}/assistants`, options);
     }
-    getSpeechToken() {
-        return this.httpClient.get(`${this.basePath}/speech/token`);
+    transcribeAudio(form, options = {}) {
+        const headers = { ...(0, utils_1.getFormDataHeaders)(form), ...options.headers };
+        return this.httpClient.post(`${this.basePath}/audio/transcription`, form, {
+            ...options,
+            headers,
+            maxBodyLength: Infinity,
+            maxContentLength: Infinity,
+            timeout: AUDIO_TRANSCRIPTION_TIMEOUT_MS,
+        });
     }
     getSkills(options = {}) {
         return this.httpClient.get(`${this.basePath}/skills`, options);