@realtimex/sdk 1.7.5 → 1.7.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-2FPRJPXR.mjs → chunk-YHNURPXJ.mjs} +72 -0
- package/dist/{errors-wfNrYt9K.d.mts → errors-7Y9damGS.d.mts} +52 -1
- package/dist/{errors-wfNrYt9K.d.ts → errors-7Y9damGS.d.ts} +52 -1
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +71 -0
- package/dist/index.mjs +1 -1
- package/dist/v1/index.d.mts +2 -2
- package/dist/v1/index.d.ts +2 -2
- package/dist/v1/index.js +73 -0
- package/dist/v1/index.mjs +3 -1
- package/package.json +1 -1
- package/skills/realtimex-moderator-sdk/SKILL.md +15 -3
- package/skills/realtimex-moderator-sdk/references/api-reference.md +37 -2
- package/skills/realtimex-moderator-sdk/references/app-concepts.md +7 -2
- package/skills/realtimex-moderator-sdk/references/known-issues.md +1 -1
|
@@ -642,6 +642,76 @@ var V1EmbedModule = class {
|
|
|
642
642
|
}
|
|
643
643
|
};
|
|
644
644
|
|
|
645
|
+
// src/v1/modules/v1RuntimeSessions.ts
|
|
646
|
+
var V1RuntimeSessionsModule = class {
|
|
647
|
+
constructor(client) {
|
|
648
|
+
this.client = client;
|
|
649
|
+
}
|
|
650
|
+
/**
|
|
651
|
+
* Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
652
|
+
* @see POST /runtime-sessions/desktop-shell/launch-spec
|
|
653
|
+
*/
|
|
654
|
+
async desktopShellLaunchSpec(body) {
|
|
655
|
+
return this.client.request("POST", `/runtime-sessions/desktop-shell/launch-spec`, body);
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
659
|
+
* @see POST /runtime-sessions/terminal-permissions/evaluate
|
|
660
|
+
*/
|
|
661
|
+
async terminalPermissionsEvaluate(body) {
|
|
662
|
+
return this.client.request("POST", `/runtime-sessions/terminal-permissions/evaluate`, body);
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* Resolve the CLI agent terminal launch command and working directory.
|
|
666
|
+
* @see POST /runtime-sessions/cli-agent/launch-spec
|
|
667
|
+
*/
|
|
668
|
+
async cliAgentLaunchSpec(body) {
|
|
669
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/launch-spec`, body);
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* Create a persistent ACP-backed CLI agent runtime session.
|
|
673
|
+
* @see POST /runtime-sessions/cli-agent
|
|
674
|
+
*/
|
|
675
|
+
async cliAgent(body) {
|
|
676
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent`, body);
|
|
677
|
+
}
|
|
678
|
+
/**
|
|
679
|
+
* Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
680
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/chat/stream
|
|
681
|
+
*/
|
|
682
|
+
async cliAgentChatStream(sessionKey, body) {
|
|
683
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/chat/stream`, body);
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* Resolve a pending permission request for a CLI agent runtime session.
|
|
687
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/permission
|
|
688
|
+
*/
|
|
689
|
+
async cliAgentPermission(sessionKey, body) {
|
|
690
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/permission`, body);
|
|
691
|
+
}
|
|
692
|
+
/**
|
|
693
|
+
* Cancel the current CLI turn for an active runtime session.
|
|
694
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/cancel
|
|
695
|
+
*/
|
|
696
|
+
async cliAgentCancel(sessionKey, body) {
|
|
697
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/cancel`, body);
|
|
698
|
+
}
|
|
699
|
+
/**
|
|
700
|
+
* Close a CLI agent runtime session and clear its control-plane metadata.
|
|
701
|
+
* @see DELETE /runtime-sessions/cli-agent/{sessionKey}
|
|
702
|
+
*/
|
|
703
|
+
async deleteCliAgent(sessionKey) {
|
|
704
|
+
return this.client.request("DELETE", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
705
|
+
}
|
|
706
|
+
/**
|
|
707
|
+
* Fetch the current state and runtime options for a CLI agent session.
|
|
708
|
+
* @see GET /runtime-sessions/cli-agent/{sessionKey}
|
|
709
|
+
*/
|
|
710
|
+
async getCliAgent(sessionKey) {
|
|
711
|
+
return this.client.request("GET", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
712
|
+
}
|
|
713
|
+
};
|
|
714
|
+
|
|
645
715
|
// src/v1/namespace.ts
|
|
646
716
|
var V1ApiNamespace = class {
|
|
647
717
|
// [GENERATED-PROPS-END]
|
|
@@ -656,6 +726,7 @@ var V1ApiNamespace = class {
|
|
|
656
726
|
this.users = new V1UsersModule(this._client);
|
|
657
727
|
this.openai = new V1OpenAIModule(this._client);
|
|
658
728
|
this.embed = new V1EmbedModule(this._client);
|
|
729
|
+
this.runtimeSessions = new V1RuntimeSessionsModule(this._client);
|
|
659
730
|
}
|
|
660
731
|
};
|
|
661
732
|
|
|
@@ -675,5 +746,6 @@ export {
|
|
|
675
746
|
V1UsersModule,
|
|
676
747
|
V1OpenAIModule,
|
|
677
748
|
V1EmbedModule,
|
|
749
|
+
V1RuntimeSessionsModule,
|
|
678
750
|
V1ApiNamespace
|
|
679
751
|
};
|
|
@@ -405,6 +405,56 @@ declare class V1EmbedModule {
|
|
|
405
405
|
deleteEmbed(embedUuid: string): Promise<unknown>;
|
|
406
406
|
}
|
|
407
407
|
|
|
408
|
+
declare class V1RuntimeSessionsModule {
|
|
409
|
+
private readonly client;
|
|
410
|
+
constructor(client: DeveloperApiClient);
|
|
411
|
+
/**
|
|
412
|
+
* Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
413
|
+
* @see POST /runtime-sessions/desktop-shell/launch-spec
|
|
414
|
+
*/
|
|
415
|
+
desktopShellLaunchSpec(body?: Record<string, unknown>): Promise<unknown>;
|
|
416
|
+
/**
|
|
417
|
+
* Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
418
|
+
* @see POST /runtime-sessions/terminal-permissions/evaluate
|
|
419
|
+
*/
|
|
420
|
+
terminalPermissionsEvaluate(body?: Record<string, unknown>): Promise<unknown>;
|
|
421
|
+
/**
|
|
422
|
+
* Resolve the CLI agent terminal launch command and working directory.
|
|
423
|
+
* @see POST /runtime-sessions/cli-agent/launch-spec
|
|
424
|
+
*/
|
|
425
|
+
cliAgentLaunchSpec(body?: Record<string, unknown>): Promise<unknown>;
|
|
426
|
+
/**
|
|
427
|
+
* Create a persistent ACP-backed CLI agent runtime session.
|
|
428
|
+
* @see POST /runtime-sessions/cli-agent
|
|
429
|
+
*/
|
|
430
|
+
cliAgent(body?: Record<string, unknown>): Promise<unknown>;
|
|
431
|
+
/**
|
|
432
|
+
* Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
433
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/chat/stream
|
|
434
|
+
*/
|
|
435
|
+
cliAgentChatStream(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
436
|
+
/**
|
|
437
|
+
* Resolve a pending permission request for a CLI agent runtime session.
|
|
438
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/permission
|
|
439
|
+
*/
|
|
440
|
+
cliAgentPermission(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
441
|
+
/**
|
|
442
|
+
* Cancel the current CLI turn for an active runtime session.
|
|
443
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/cancel
|
|
444
|
+
*/
|
|
445
|
+
cliAgentCancel(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
446
|
+
/**
|
|
447
|
+
* Close a CLI agent runtime session and clear its control-plane metadata.
|
|
448
|
+
* @see DELETE /runtime-sessions/cli-agent/{sessionKey}
|
|
449
|
+
*/
|
|
450
|
+
deleteCliAgent(sessionKey: string): Promise<unknown>;
|
|
451
|
+
/**
|
|
452
|
+
* Fetch the current state and runtime options for a CLI agent session.
|
|
453
|
+
* @see GET /runtime-sessions/cli-agent/{sessionKey}
|
|
454
|
+
*/
|
|
455
|
+
getCliAgent(sessionKey: string): Promise<unknown>;
|
|
456
|
+
}
|
|
457
|
+
|
|
408
458
|
/**
|
|
409
459
|
* V1ApiNamespace - Container for all RealtimeX Developer API (v1) modules.
|
|
410
460
|
*
|
|
@@ -428,6 +478,7 @@ declare class V1ApiNamespace {
|
|
|
428
478
|
users: V1UsersModule;
|
|
429
479
|
openai: V1OpenAIModule;
|
|
430
480
|
embed: V1EmbedModule;
|
|
481
|
+
runtimeSessions: V1RuntimeSessionsModule;
|
|
431
482
|
constructor(baseUrl: string, apiKey: string, appId?: string);
|
|
432
483
|
}
|
|
433
484
|
|
|
@@ -452,4 +503,4 @@ declare class ServerError extends DeveloperApiError {
|
|
|
452
503
|
constructor(message?: string);
|
|
453
504
|
}
|
|
454
505
|
|
|
455
|
-
export { AuthenticationError as A, DeveloperApiClient as D, NotFoundError as N, ServerError as S, V1ApiNamespace as V, DeveloperApiError as a, ValidationError as b, V1AuthModule as c, V1AdminModule as d, V1DocumentModule as e, V1WorkspaceModule as f, V1SystemModule as g, V1ThreadModule as h, V1UsersModule as i, V1OpenAIModule as j, V1EmbedModule as k };
|
|
506
|
+
export { AuthenticationError as A, DeveloperApiClient as D, NotFoundError as N, ServerError as S, V1ApiNamespace as V, DeveloperApiError as a, ValidationError as b, V1AuthModule as c, V1AdminModule as d, V1DocumentModule as e, V1WorkspaceModule as f, V1SystemModule as g, V1ThreadModule as h, V1UsersModule as i, V1OpenAIModule as j, V1EmbedModule as k, V1RuntimeSessionsModule as l };
|
|
@@ -405,6 +405,56 @@ declare class V1EmbedModule {
|
|
|
405
405
|
deleteEmbed(embedUuid: string): Promise<unknown>;
|
|
406
406
|
}
|
|
407
407
|
|
|
408
|
+
declare class V1RuntimeSessionsModule {
|
|
409
|
+
private readonly client;
|
|
410
|
+
constructor(client: DeveloperApiClient);
|
|
411
|
+
/**
|
|
412
|
+
* Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
413
|
+
* @see POST /runtime-sessions/desktop-shell/launch-spec
|
|
414
|
+
*/
|
|
415
|
+
desktopShellLaunchSpec(body?: Record<string, unknown>): Promise<unknown>;
|
|
416
|
+
/**
|
|
417
|
+
* Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
418
|
+
* @see POST /runtime-sessions/terminal-permissions/evaluate
|
|
419
|
+
*/
|
|
420
|
+
terminalPermissionsEvaluate(body?: Record<string, unknown>): Promise<unknown>;
|
|
421
|
+
/**
|
|
422
|
+
* Resolve the CLI agent terminal launch command and working directory.
|
|
423
|
+
* @see POST /runtime-sessions/cli-agent/launch-spec
|
|
424
|
+
*/
|
|
425
|
+
cliAgentLaunchSpec(body?: Record<string, unknown>): Promise<unknown>;
|
|
426
|
+
/**
|
|
427
|
+
* Create a persistent ACP-backed CLI agent runtime session.
|
|
428
|
+
* @see POST /runtime-sessions/cli-agent
|
|
429
|
+
*/
|
|
430
|
+
cliAgent(body?: Record<string, unknown>): Promise<unknown>;
|
|
431
|
+
/**
|
|
432
|
+
* Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
433
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/chat/stream
|
|
434
|
+
*/
|
|
435
|
+
cliAgentChatStream(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
436
|
+
/**
|
|
437
|
+
* Resolve a pending permission request for a CLI agent runtime session.
|
|
438
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/permission
|
|
439
|
+
*/
|
|
440
|
+
cliAgentPermission(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
441
|
+
/**
|
|
442
|
+
* Cancel the current CLI turn for an active runtime session.
|
|
443
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/cancel
|
|
444
|
+
*/
|
|
445
|
+
cliAgentCancel(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>;
|
|
446
|
+
/**
|
|
447
|
+
* Close a CLI agent runtime session and clear its control-plane metadata.
|
|
448
|
+
* @see DELETE /runtime-sessions/cli-agent/{sessionKey}
|
|
449
|
+
*/
|
|
450
|
+
deleteCliAgent(sessionKey: string): Promise<unknown>;
|
|
451
|
+
/**
|
|
452
|
+
* Fetch the current state and runtime options for a CLI agent session.
|
|
453
|
+
* @see GET /runtime-sessions/cli-agent/{sessionKey}
|
|
454
|
+
*/
|
|
455
|
+
getCliAgent(sessionKey: string): Promise<unknown>;
|
|
456
|
+
}
|
|
457
|
+
|
|
408
458
|
/**
|
|
409
459
|
* V1ApiNamespace - Container for all RealtimeX Developer API (v1) modules.
|
|
410
460
|
*
|
|
@@ -428,6 +478,7 @@ declare class V1ApiNamespace {
|
|
|
428
478
|
users: V1UsersModule;
|
|
429
479
|
openai: V1OpenAIModule;
|
|
430
480
|
embed: V1EmbedModule;
|
|
481
|
+
runtimeSessions: V1RuntimeSessionsModule;
|
|
431
482
|
constructor(baseUrl: string, apiKey: string, appId?: string);
|
|
432
483
|
}
|
|
433
484
|
|
|
@@ -452,4 +503,4 @@ declare class ServerError extends DeveloperApiError {
|
|
|
452
503
|
constructor(message?: string);
|
|
453
504
|
}
|
|
454
505
|
|
|
455
|
-
export { AuthenticationError as A, DeveloperApiClient as D, NotFoundError as N, ServerError as S, V1ApiNamespace as V, DeveloperApiError as a, ValidationError as b, V1AuthModule as c, V1AdminModule as d, V1DocumentModule as e, V1WorkspaceModule as f, V1SystemModule as g, V1ThreadModule as h, V1UsersModule as i, V1OpenAIModule as j, V1EmbedModule as k };
|
|
506
|
+
export { AuthenticationError as A, DeveloperApiClient as D, NotFoundError as N, ServerError as S, V1ApiNamespace as V, DeveloperApiError as a, ValidationError as b, V1AuthModule as c, V1AdminModule as d, V1DocumentModule as e, V1WorkspaceModule as f, V1SystemModule as g, V1ThreadModule as h, V1UsersModule as i, V1OpenAIModule as j, V1EmbedModule as k, V1RuntimeSessionsModule as l };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { V as V1ApiNamespace } from './errors-
|
|
2
|
-
export { A as AuthenticationError, D as DeveloperApiClient, a as DeveloperApiError, N as NotFoundError, S as ServerError, b as ValidationError } from './errors-
|
|
1
|
+
import { V as V1ApiNamespace } from './errors-7Y9damGS.mjs';
|
|
2
|
+
export { A as AuthenticationError, D as DeveloperApiClient, a as DeveloperApiError, N as NotFoundError, S as ServerError, b as ValidationError } from './errors-7Y9damGS.mjs';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* RealtimeX Local App SDK - Types
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { V as V1ApiNamespace } from './errors-
|
|
2
|
-
export { A as AuthenticationError, D as DeveloperApiClient, a as DeveloperApiError, N as NotFoundError, S as ServerError, b as ValidationError } from './errors-
|
|
1
|
+
import { V as V1ApiNamespace } from './errors-7Y9damGS.js';
|
|
2
|
+
export { A as AuthenticationError, D as DeveloperApiClient, a as DeveloperApiError, N as NotFoundError, S as ServerError, b as ValidationError } from './errors-7Y9damGS.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* RealtimeX Local App SDK - Types
|
package/dist/index.js
CHANGED
|
@@ -3687,6 +3687,76 @@ var V1EmbedModule = class {
|
|
|
3687
3687
|
}
|
|
3688
3688
|
};
|
|
3689
3689
|
|
|
3690
|
+
// src/v1/modules/v1RuntimeSessions.ts
|
|
3691
|
+
var V1RuntimeSessionsModule = class {
|
|
3692
|
+
constructor(client) {
|
|
3693
|
+
this.client = client;
|
|
3694
|
+
}
|
|
3695
|
+
/**
|
|
3696
|
+
* Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
3697
|
+
* @see POST /runtime-sessions/desktop-shell/launch-spec
|
|
3698
|
+
*/
|
|
3699
|
+
async desktopShellLaunchSpec(body) {
|
|
3700
|
+
return this.client.request("POST", `/runtime-sessions/desktop-shell/launch-spec`, body);
|
|
3701
|
+
}
|
|
3702
|
+
/**
|
|
3703
|
+
* Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
3704
|
+
* @see POST /runtime-sessions/terminal-permissions/evaluate
|
|
3705
|
+
*/
|
|
3706
|
+
async terminalPermissionsEvaluate(body) {
|
|
3707
|
+
return this.client.request("POST", `/runtime-sessions/terminal-permissions/evaluate`, body);
|
|
3708
|
+
}
|
|
3709
|
+
/**
|
|
3710
|
+
* Resolve the CLI agent terminal launch command and working directory.
|
|
3711
|
+
* @see POST /runtime-sessions/cli-agent/launch-spec
|
|
3712
|
+
*/
|
|
3713
|
+
async cliAgentLaunchSpec(body) {
|
|
3714
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/launch-spec`, body);
|
|
3715
|
+
}
|
|
3716
|
+
/**
|
|
3717
|
+
* Create a persistent ACP-backed CLI agent runtime session.
|
|
3718
|
+
* @see POST /runtime-sessions/cli-agent
|
|
3719
|
+
*/
|
|
3720
|
+
async cliAgent(body) {
|
|
3721
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent`, body);
|
|
3722
|
+
}
|
|
3723
|
+
/**
|
|
3724
|
+
* Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
3725
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/chat/stream
|
|
3726
|
+
*/
|
|
3727
|
+
async cliAgentChatStream(sessionKey, body) {
|
|
3728
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/chat/stream`, body);
|
|
3729
|
+
}
|
|
3730
|
+
/**
|
|
3731
|
+
* Resolve a pending permission request for a CLI agent runtime session.
|
|
3732
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/permission
|
|
3733
|
+
*/
|
|
3734
|
+
async cliAgentPermission(sessionKey, body) {
|
|
3735
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/permission`, body);
|
|
3736
|
+
}
|
|
3737
|
+
/**
|
|
3738
|
+
* Cancel the current CLI turn for an active runtime session.
|
|
3739
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/cancel
|
|
3740
|
+
*/
|
|
3741
|
+
async cliAgentCancel(sessionKey, body) {
|
|
3742
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/cancel`, body);
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* Close a CLI agent runtime session and clear its control-plane metadata.
|
|
3746
|
+
* @see DELETE /runtime-sessions/cli-agent/{sessionKey}
|
|
3747
|
+
*/
|
|
3748
|
+
async deleteCliAgent(sessionKey) {
|
|
3749
|
+
return this.client.request("DELETE", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
3750
|
+
}
|
|
3751
|
+
/**
|
|
3752
|
+
* Fetch the current state and runtime options for a CLI agent session.
|
|
3753
|
+
* @see GET /runtime-sessions/cli-agent/{sessionKey}
|
|
3754
|
+
*/
|
|
3755
|
+
async getCliAgent(sessionKey) {
|
|
3756
|
+
return this.client.request("GET", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
3757
|
+
}
|
|
3758
|
+
};
|
|
3759
|
+
|
|
3690
3760
|
// src/v1/namespace.ts
|
|
3691
3761
|
var V1ApiNamespace = class {
|
|
3692
3762
|
// [GENERATED-PROPS-END]
|
|
@@ -3701,6 +3771,7 @@ var V1ApiNamespace = class {
|
|
|
3701
3771
|
this.users = new V1UsersModule(this._client);
|
|
3702
3772
|
this.openai = new V1OpenAIModule(this._client);
|
|
3703
3773
|
this.embed = new V1EmbedModule(this._client);
|
|
3774
|
+
this.runtimeSessions = new V1RuntimeSessionsModule(this._client);
|
|
3704
3775
|
}
|
|
3705
3776
|
};
|
|
3706
3777
|
|
package/dist/index.mjs
CHANGED
package/dist/v1/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { D as DeveloperApiClient } from '../errors-
|
|
2
|
-
export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-
|
|
1
|
+
import { D as DeveloperApiClient } from '../errors-7Y9damGS.mjs';
|
|
2
|
+
export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, l as V1RuntimeSessionsModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-7Y9damGS.mjs';
|
|
3
3
|
|
|
4
4
|
interface WorkspaceStreamChunk {
|
|
5
5
|
/** The text fragment emitted by this SSE event */
|
package/dist/v1/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { D as DeveloperApiClient } from '../errors-
|
|
2
|
-
export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-
|
|
1
|
+
import { D as DeveloperApiClient } from '../errors-7Y9damGS.js';
|
|
2
|
+
export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, l as V1RuntimeSessionsModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-7Y9damGS.js';
|
|
3
3
|
|
|
4
4
|
interface WorkspaceStreamChunk {
|
|
5
5
|
/** The text fragment emitted by this SSE event */
|
package/dist/v1/index.js
CHANGED
|
@@ -31,6 +31,7 @@ __export(v1_exports, {
|
|
|
31
31
|
V1DocumentModule: () => V1DocumentModule,
|
|
32
32
|
V1EmbedModule: () => V1EmbedModule,
|
|
33
33
|
V1OpenAIModule: () => V1OpenAIModule,
|
|
34
|
+
V1RuntimeSessionsModule: () => V1RuntimeSessionsModule,
|
|
34
35
|
V1SystemModule: () => V1SystemModule,
|
|
35
36
|
V1ThreadModule: () => V1ThreadModule,
|
|
36
37
|
V1UsersModule: () => V1UsersModule,
|
|
@@ -687,6 +688,76 @@ var V1EmbedModule = class {
|
|
|
687
688
|
}
|
|
688
689
|
};
|
|
689
690
|
|
|
691
|
+
// src/v1/modules/v1RuntimeSessions.ts
|
|
692
|
+
var V1RuntimeSessionsModule = class {
|
|
693
|
+
constructor(client) {
|
|
694
|
+
this.client = client;
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
698
|
+
* @see POST /runtime-sessions/desktop-shell/launch-spec
|
|
699
|
+
*/
|
|
700
|
+
async desktopShellLaunchSpec(body) {
|
|
701
|
+
return this.client.request("POST", `/runtime-sessions/desktop-shell/launch-spec`, body);
|
|
702
|
+
}
|
|
703
|
+
/**
|
|
704
|
+
* Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
705
|
+
* @see POST /runtime-sessions/terminal-permissions/evaluate
|
|
706
|
+
*/
|
|
707
|
+
async terminalPermissionsEvaluate(body) {
|
|
708
|
+
return this.client.request("POST", `/runtime-sessions/terminal-permissions/evaluate`, body);
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* Resolve the CLI agent terminal launch command and working directory.
|
|
712
|
+
* @see POST /runtime-sessions/cli-agent/launch-spec
|
|
713
|
+
*/
|
|
714
|
+
async cliAgentLaunchSpec(body) {
|
|
715
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/launch-spec`, body);
|
|
716
|
+
}
|
|
717
|
+
/**
|
|
718
|
+
* Create a persistent ACP-backed CLI agent runtime session.
|
|
719
|
+
* @see POST /runtime-sessions/cli-agent
|
|
720
|
+
*/
|
|
721
|
+
async cliAgent(body) {
|
|
722
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent`, body);
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
725
|
+
* Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
726
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/chat/stream
|
|
727
|
+
*/
|
|
728
|
+
async cliAgentChatStream(sessionKey, body) {
|
|
729
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/chat/stream`, body);
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* Resolve a pending permission request for a CLI agent runtime session.
|
|
733
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/permission
|
|
734
|
+
*/
|
|
735
|
+
async cliAgentPermission(sessionKey, body) {
|
|
736
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/permission`, body);
|
|
737
|
+
}
|
|
738
|
+
/**
|
|
739
|
+
* Cancel the current CLI turn for an active runtime session.
|
|
740
|
+
* @see POST /runtime-sessions/cli-agent/{sessionKey}/cancel
|
|
741
|
+
*/
|
|
742
|
+
async cliAgentCancel(sessionKey, body) {
|
|
743
|
+
return this.client.request("POST", `/runtime-sessions/cli-agent/${sessionKey}/cancel`, body);
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* Close a CLI agent runtime session and clear its control-plane metadata.
|
|
747
|
+
* @see DELETE /runtime-sessions/cli-agent/{sessionKey}
|
|
748
|
+
*/
|
|
749
|
+
async deleteCliAgent(sessionKey) {
|
|
750
|
+
return this.client.request("DELETE", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* Fetch the current state and runtime options for a CLI agent session.
|
|
754
|
+
* @see GET /runtime-sessions/cli-agent/{sessionKey}
|
|
755
|
+
*/
|
|
756
|
+
async getCliAgent(sessionKey) {
|
|
757
|
+
return this.client.request("GET", `/runtime-sessions/cli-agent/${sessionKey}`);
|
|
758
|
+
}
|
|
759
|
+
};
|
|
760
|
+
|
|
690
761
|
// src/v1/namespace.ts
|
|
691
762
|
var V1ApiNamespace = class {
|
|
692
763
|
// [GENERATED-PROPS-END]
|
|
@@ -701,6 +772,7 @@ var V1ApiNamespace = class {
|
|
|
701
772
|
this.users = new V1UsersModule(this._client);
|
|
702
773
|
this.openai = new V1OpenAIModule(this._client);
|
|
703
774
|
this.embed = new V1EmbedModule(this._client);
|
|
775
|
+
this.runtimeSessions = new V1RuntimeSessionsModule(this._client);
|
|
704
776
|
}
|
|
705
777
|
};
|
|
706
778
|
|
|
@@ -830,6 +902,7 @@ async function uploadFileToFolder(client, file, folderName, options = {}) {
|
|
|
830
902
|
V1DocumentModule,
|
|
831
903
|
V1EmbedModule,
|
|
832
904
|
V1OpenAIModule,
|
|
905
|
+
V1RuntimeSessionsModule,
|
|
833
906
|
V1SystemModule,
|
|
834
907
|
V1ThreadModule,
|
|
835
908
|
V1UsersModule,
|
package/dist/v1/index.mjs
CHANGED
|
@@ -10,12 +10,13 @@ import {
|
|
|
10
10
|
V1DocumentModule,
|
|
11
11
|
V1EmbedModule,
|
|
12
12
|
V1OpenAIModule,
|
|
13
|
+
V1RuntimeSessionsModule,
|
|
13
14
|
V1SystemModule,
|
|
14
15
|
V1ThreadModule,
|
|
15
16
|
V1UsersModule,
|
|
16
17
|
V1WorkspaceModule,
|
|
17
18
|
ValidationError
|
|
18
|
-
} from "../chunk-
|
|
19
|
+
} from "../chunk-YHNURPXJ.mjs";
|
|
19
20
|
|
|
20
21
|
// src/v1/overrides/v1WorkspaceStreaming.ts
|
|
21
22
|
async function* streamWorkspaceChat(client, slug, body) {
|
|
@@ -142,6 +143,7 @@ export {
|
|
|
142
143
|
V1DocumentModule,
|
|
143
144
|
V1EmbedModule,
|
|
144
145
|
V1OpenAIModule,
|
|
146
|
+
V1RuntimeSessionsModule,
|
|
145
147
|
V1SystemModule,
|
|
146
148
|
V1ThreadModule,
|
|
147
149
|
V1UsersModule,
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: realtimex-moderator-sdk
|
|
3
3
|
description: Control and interact with the RealTimeX application through its Node.js SDK. This skill should be used when users want to manage workspaces, threads, agents, activities, LLM chat, vector store, MCP tools, ACP agent sessions, TTS/STT, or any other RealTimeX platform feature via the API. All method signatures are verified against the SDK source code.
|
|
4
|
-
generated: 2026-04
|
|
5
|
-
sdk_version: 1.7.
|
|
4
|
+
generated: 2026-05-04
|
|
5
|
+
sdk_version: 1.7.6
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# RealTimeX Moderator (SDK Source-Verified)
|
|
9
9
|
|
|
10
|
-
Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.
|
|
10
|
+
Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.6**. Authentication is automatic when running inside RealtimeX.
|
|
11
11
|
|
|
12
12
|
`<SKILL_DIR>` below refers to the directory containing this SKILL.md.
|
|
13
13
|
|
|
@@ -44,6 +44,18 @@ Scripts using the SDK must exit explicitly — `process.exit(0)` on success, `pr
|
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
+
## Runtime Sessions
|
|
48
|
+
|
|
49
|
+
In this SDK, **Runtime Sessions** means the CLI Agent in **Terminal mode**. Use `sdk.agent.*` for that path.
|
|
50
|
+
|
|
51
|
+
This is separate from ACP mode:
|
|
52
|
+
- `sdk.agent.*` = Runtime Sessions = CLI Agent / Terminal mode
|
|
53
|
+
- `sdk.acpAgent.*` = ACP-backed CLI agent sessions
|
|
54
|
+
|
|
55
|
+
If a user refers to the v1/OpenAPI tag `Runtime Sessions`, interpret that as the Terminal mode session flow, not ACP.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
47
59
|
## ACP Session Management
|
|
48
60
|
|
|
49
61
|
ACP sessions are persistent agent processes. **Always reuse sessions** across turns instead of spawning a new process for every message — it preserves context and is far more efficient.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# RealTimeX SDK — API Reference
|
|
2
2
|
|
|
3
|
-
> Auto-generated from `@realtimex/sdk` source · v**1.7.
|
|
3
|
+
> Auto-generated from `@realtimex/sdk` source · v**1.7.6** · 2026-05-04
|
|
4
4
|
|
|
5
5
|
**Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
|
|
6
6
|
**Developer Mode auth:** `Authorization: Bearer <apiKey>`
|
|
@@ -503,7 +503,7 @@ outcome?: string
|
|
|
503
503
|
|
|
504
504
|
---
|
|
505
505
|
|
|
506
|
-
## sdk.agent —
|
|
506
|
+
## sdk.agent — Runtime Sessions (CLI Agent / Terminal mode)
|
|
507
507
|
|
|
508
508
|
### `AgentModule`
|
|
509
509
|
|
|
@@ -918,6 +918,41 @@ async listVectorStores(): Promise<unknown>
|
|
|
918
918
|
|
|
919
919
|
---
|
|
920
920
|
|
|
921
|
+
## sdk.v1.runtimeSessions — Runtime Sessions (CLI Agent / Terminal mode)
|
|
922
|
+
|
|
923
|
+
### `V1RuntimeSessionsModule`
|
|
924
|
+
|
|
925
|
+
```ts
|
|
926
|
+
// Resolve the desktop shell launch working directory for a workspace or thread context.
|
|
927
|
+
async desktopShellLaunchSpec(body?: Record<string, unknown>): Promise<unknown>
|
|
928
|
+
|
|
929
|
+
// Evaluate the runtime terminal permission policy for a pending CLI action.
|
|
930
|
+
async terminalPermissionsEvaluate(body?: Record<string, unknown>): Promise<unknown>
|
|
931
|
+
|
|
932
|
+
// Resolve the CLI agent terminal launch command and working directory.
|
|
933
|
+
async cliAgentLaunchSpec(body?: Record<string, unknown>): Promise<unknown>
|
|
934
|
+
|
|
935
|
+
// Create a persistent ACP-backed CLI agent runtime session.
|
|
936
|
+
async cliAgent(body?: Record<string, unknown>): Promise<unknown>
|
|
937
|
+
|
|
938
|
+
// Stream a chat turn to an existing CLI agent runtime session using Server-Sent Events.
|
|
939
|
+
async cliAgentChatStream(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>
|
|
940
|
+
|
|
941
|
+
// Resolve a pending permission request for a CLI agent runtime session.
|
|
942
|
+
async cliAgentPermission(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>
|
|
943
|
+
|
|
944
|
+
// Cancel the current CLI turn for an active runtime session.
|
|
945
|
+
async cliAgentCancel(sessionKey: string, body?: Record<string, unknown>): Promise<unknown>
|
|
946
|
+
|
|
947
|
+
// Close a CLI agent runtime session and clear its control-plane metadata.
|
|
948
|
+
async deleteCliAgent(sessionKey: string): Promise<unknown>
|
|
949
|
+
|
|
950
|
+
// Fetch the current state and runtime options for a CLI agent session.
|
|
951
|
+
async getCliAgent(sessionKey: string): Promise<unknown>
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
---
|
|
955
|
+
|
|
921
956
|
## sdk.v1.sttApi — v1 Stt Api
|
|
922
957
|
|
|
923
958
|
### `V1SttApiModule`
|
|
@@ -55,7 +55,9 @@ monitor context (calendar, documents, threads) and take autonomous actions.
|
|
|
55
55
|
| `timezone` | `null` | — |
|
|
56
56
|
| `llmProvider` | `DEFAULT_AMBIENT_LLM_PROVIDER` | — |
|
|
57
57
|
| `llmModel` | `DEFAULT_AMBIENT_LLM_MODEL` | autoPilotEnabled: when true, the CLI ACP agent will automatically select |
|
|
58
|
-
| `autoPilotEnabled` | `false` |
|
|
58
|
+
| `autoPilotEnabled` | `false` | resumeSession: when true, each heartbeat execution resumes the last ACP |
|
|
59
|
+
| `resumeSession` | `false` | — |
|
|
60
|
+
| `customInstructions` | `""` | — |
|
|
59
61
|
|
|
60
62
|
### Calendar Routines
|
|
61
63
|
|
|
@@ -121,6 +123,7 @@ Skills are loaded from git repositories, zip files, or installed plugins.
|
|
|
121
123
|
|---|---|
|
|
122
124
|
| `repo` | Skill loaded from a git repository URL |
|
|
123
125
|
| `zip` | Skill loaded from an uploaded .zip file |
|
|
126
|
+
| `local-path` | — |
|
|
124
127
|
|
|
125
128
|
### Skill Scopes
|
|
126
129
|
|
|
@@ -781,13 +784,15 @@ A skill (tool-set) available to agents. Can come from a git repo, zip file, or p
|
|
|
781
784
|
|---|---|---|---|
|
|
782
785
|
| `name` | String | — | — |
|
|
783
786
|
| `display_name` | String | — | — |
|
|
787
|
+
| `normalized_display_name` | String? | — | — |
|
|
784
788
|
| `description` | String? | — | — |
|
|
785
789
|
| `skill_id` | String? | — | Store's ID, used when synced from marketplace |
|
|
786
790
|
| `repository_url` | String? | — | — |
|
|
787
791
|
| `ref` | String? | — | Git ref (branch/tag) |
|
|
788
792
|
| `skill_path` | String? | — | Path within repository |
|
|
789
793
|
| `zip_file` | String? | — | Path to local zip file |
|
|
790
|
-
| `
|
|
794
|
+
| `local_path` | String? | — | Absolute source path for local-path type skills |
|
|
795
|
+
| `type` | String | repo | 'repo' | 'zip' | 'local-path' |
|
|
791
796
|
| `scope` | String | uploaded | 'global' | 'workspace' | 'local-app' | 'uploaded' | 'plugin' |
|
|
792
797
|
| `status` | String | draft | 'draft' | 'published' |
|
|
793
798
|
| `pending_publish` | Boolean | true | Tracks if code/ZIP changed and needs new version publish |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Known Issues — Source-Detected
|
|
2
2
|
|
|
3
|
-
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.
|
|
3
|
+
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.6** · 2026-05-04
|
|
4
4
|
|
|
5
5
|
Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
|
|
6
6
|
|