@soederpop/luca 0.0.31 → 0.0.32
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/package.json +1 -1
- package/src/agi/features/assistant.ts +1 -0
- package/src/bootstrap/generated.ts +1 -1
- package/src/introspection/generated.agi.ts +1270 -1270
- package/src/introspection/generated.node.ts +1 -1
- package/src/introspection/generated.web.ts +1 -1
- package/src/scaffolds/generated.ts +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { setBuildTimeData, setContainerBuildTimeData } from './index.js';
|
|
2
2
|
|
|
3
3
|
// Auto-generated introspection registry data
|
|
4
|
-
// Generated at: 2026-03-24T09:
|
|
4
|
+
// Generated at: 2026-03-24T09:09:09.989Z
|
|
5
5
|
|
|
6
6
|
setBuildTimeData('features.googleDocs', {
|
|
7
7
|
"id": "features.googleDocs",
|
|
@@ -11892,270 +11892,6 @@ setBuildTimeData('clients.supabase', {
|
|
|
11892
11892
|
]
|
|
11893
11893
|
});
|
|
11894
11894
|
|
|
11895
|
-
setBuildTimeData('clients.elevenlabs', {
|
|
11896
|
-
"id": "clients.elevenlabs",
|
|
11897
|
-
"description": "ElevenLabs client — text-to-speech synthesis via the ElevenLabs REST API. Provides methods for listing voices, listing models, and generating speech audio. Audio is returned as a Buffer; use `say()` for a convenience method that writes to disk.",
|
|
11898
|
-
"shortcut": "clients.elevenlabs",
|
|
11899
|
-
"className": "ElevenLabsClient",
|
|
11900
|
-
"methods": {
|
|
11901
|
-
"beforeRequest": {
|
|
11902
|
-
"description": "Inject the xi-api-key header before each request.",
|
|
11903
|
-
"parameters": {},
|
|
11904
|
-
"required": [],
|
|
11905
|
-
"returns": "void"
|
|
11906
|
-
},
|
|
11907
|
-
"connect": {
|
|
11908
|
-
"description": "Validate the API key by listing available models.",
|
|
11909
|
-
"parameters": {},
|
|
11910
|
-
"required": [],
|
|
11911
|
-
"returns": "Promise<this>",
|
|
11912
|
-
"examples": [
|
|
11913
|
-
{
|
|
11914
|
-
"language": "ts",
|
|
11915
|
-
"code": "await el.connect()"
|
|
11916
|
-
}
|
|
11917
|
-
]
|
|
11918
|
-
},
|
|
11919
|
-
"listVoices": {
|
|
11920
|
-
"description": "List available voices with optional search and filtering.",
|
|
11921
|
-
"parameters": {
|
|
11922
|
-
"options": {
|
|
11923
|
-
"type": "{\n search?: string\n category?: string\n voice_type?: string\n page_size?: number\n next_page_token?: string\n }",
|
|
11924
|
-
"description": "Query parameters for filtering voices"
|
|
11925
|
-
}
|
|
11926
|
-
},
|
|
11927
|
-
"required": [],
|
|
11928
|
-
"returns": "Promise<any>",
|
|
11929
|
-
"examples": [
|
|
11930
|
-
{
|
|
11931
|
-
"language": "ts",
|
|
11932
|
-
"code": "const voices = await el.listVoices()\nconst premade = await el.listVoices({ category: 'premade' })"
|
|
11933
|
-
}
|
|
11934
|
-
]
|
|
11935
|
-
},
|
|
11936
|
-
"getVoice": {
|
|
11937
|
-
"description": "Get details for a single voice.",
|
|
11938
|
-
"parameters": {
|
|
11939
|
-
"voiceId": {
|
|
11940
|
-
"type": "string",
|
|
11941
|
-
"description": "The voice ID to look up"
|
|
11942
|
-
}
|
|
11943
|
-
},
|
|
11944
|
-
"required": [
|
|
11945
|
-
"voiceId"
|
|
11946
|
-
],
|
|
11947
|
-
"returns": "Promise<any>",
|
|
11948
|
-
"examples": [
|
|
11949
|
-
{
|
|
11950
|
-
"language": "ts",
|
|
11951
|
-
"code": "const voice = await el.getVoice('21m00Tcm4TlvDq8ikWAM')\nconsole.log(voice.name, voice.settings)"
|
|
11952
|
-
}
|
|
11953
|
-
]
|
|
11954
|
-
},
|
|
11955
|
-
"listModels": {
|
|
11956
|
-
"description": "List available TTS models.",
|
|
11957
|
-
"parameters": {},
|
|
11958
|
-
"required": [],
|
|
11959
|
-
"returns": "Promise<any[]>",
|
|
11960
|
-
"examples": [
|
|
11961
|
-
{
|
|
11962
|
-
"language": "ts",
|
|
11963
|
-
"code": "const models = await el.listModels()\nconsole.log(models.map(m => m.model_id))"
|
|
11964
|
-
}
|
|
11965
|
-
]
|
|
11966
|
-
},
|
|
11967
|
-
"synthesize": {
|
|
11968
|
-
"description": "Synthesize speech from text, returning audio as a Buffer.",
|
|
11969
|
-
"parameters": {
|
|
11970
|
-
"text": {
|
|
11971
|
-
"type": "string",
|
|
11972
|
-
"description": "The text to convert to speech"
|
|
11973
|
-
},
|
|
11974
|
-
"options": {
|
|
11975
|
-
"type": "SynthesizeOptions",
|
|
11976
|
-
"description": "Voice, model, format, and voice settings overrides",
|
|
11977
|
-
"properties": {
|
|
11978
|
-
"voiceId": {
|
|
11979
|
-
"type": "string",
|
|
11980
|
-
"description": ""
|
|
11981
|
-
},
|
|
11982
|
-
"modelId": {
|
|
11983
|
-
"type": "string",
|
|
11984
|
-
"description": ""
|
|
11985
|
-
},
|
|
11986
|
-
"outputFormat": {
|
|
11987
|
-
"type": "string",
|
|
11988
|
-
"description": ""
|
|
11989
|
-
},
|
|
11990
|
-
"voiceSettings": {
|
|
11991
|
-
"type": "ElevenLabsVoiceSettings",
|
|
11992
|
-
"description": ""
|
|
11993
|
-
},
|
|
11994
|
-
"disableCache": {
|
|
11995
|
-
"type": "boolean",
|
|
11996
|
-
"description": ""
|
|
11997
|
-
}
|
|
11998
|
-
}
|
|
11999
|
-
}
|
|
12000
|
-
},
|
|
12001
|
-
"required": [
|
|
12002
|
-
"text"
|
|
12003
|
-
],
|
|
12004
|
-
"returns": "Promise<Buffer>",
|
|
12005
|
-
"examples": [
|
|
12006
|
-
{
|
|
12007
|
-
"language": "ts",
|
|
12008
|
-
"code": "const audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data\n\nconst custom = await el.synthesize('Hello', {\n voiceId: '21m00Tcm4TlvDq8ikWAM',\n voiceSettings: { stability: 0.5, similarityBoost: 0.8 }\n})"
|
|
12009
|
-
}
|
|
12010
|
-
]
|
|
12011
|
-
},
|
|
12012
|
-
"say": {
|
|
12013
|
-
"description": "Synthesize speech and write the audio to a file.",
|
|
12014
|
-
"parameters": {
|
|
12015
|
-
"text": {
|
|
12016
|
-
"type": "string",
|
|
12017
|
-
"description": "The text to convert to speech"
|
|
12018
|
-
},
|
|
12019
|
-
"outputPath": {
|
|
12020
|
-
"type": "string",
|
|
12021
|
-
"description": "File path to write the audio to"
|
|
12022
|
-
},
|
|
12023
|
-
"options": {
|
|
12024
|
-
"type": "SynthesizeOptions",
|
|
12025
|
-
"description": "Voice, model, format, and voice settings overrides",
|
|
12026
|
-
"properties": {
|
|
12027
|
-
"voiceId": {
|
|
12028
|
-
"type": "string",
|
|
12029
|
-
"description": ""
|
|
12030
|
-
},
|
|
12031
|
-
"modelId": {
|
|
12032
|
-
"type": "string",
|
|
12033
|
-
"description": ""
|
|
12034
|
-
},
|
|
12035
|
-
"outputFormat": {
|
|
12036
|
-
"type": "string",
|
|
12037
|
-
"description": ""
|
|
12038
|
-
},
|
|
12039
|
-
"voiceSettings": {
|
|
12040
|
-
"type": "ElevenLabsVoiceSettings",
|
|
12041
|
-
"description": ""
|
|
12042
|
-
},
|
|
12043
|
-
"disableCache": {
|
|
12044
|
-
"type": "boolean",
|
|
12045
|
-
"description": ""
|
|
12046
|
-
}
|
|
12047
|
-
}
|
|
12048
|
-
}
|
|
12049
|
-
},
|
|
12050
|
-
"required": [
|
|
12051
|
-
"text",
|
|
12052
|
-
"outputPath"
|
|
12053
|
-
],
|
|
12054
|
-
"returns": "Promise<string>",
|
|
12055
|
-
"examples": [
|
|
12056
|
-
{
|
|
12057
|
-
"language": "ts",
|
|
12058
|
-
"code": "const path = await el.say('Hello world', './hello.mp3')\nconsole.log(`Audio saved to ${path}`)"
|
|
12059
|
-
}
|
|
12060
|
-
]
|
|
12061
|
-
}
|
|
12062
|
-
},
|
|
12063
|
-
"getters": {
|
|
12064
|
-
"apiKey": {
|
|
12065
|
-
"description": "The resolved API key from options or environment.",
|
|
12066
|
-
"returns": "string"
|
|
12067
|
-
}
|
|
12068
|
-
},
|
|
12069
|
-
"events": {
|
|
12070
|
-
"failure": {
|
|
12071
|
-
"name": "failure",
|
|
12072
|
-
"description": "Event emitted by ElevenLabsClient",
|
|
12073
|
-
"arguments": {}
|
|
12074
|
-
},
|
|
12075
|
-
"voices": {
|
|
12076
|
-
"name": "voices",
|
|
12077
|
-
"description": "Event emitted by ElevenLabsClient",
|
|
12078
|
-
"arguments": {}
|
|
12079
|
-
},
|
|
12080
|
-
"speech": {
|
|
12081
|
-
"name": "speech",
|
|
12082
|
-
"description": "Event emitted by ElevenLabsClient",
|
|
12083
|
-
"arguments": {}
|
|
12084
|
-
}
|
|
12085
|
-
},
|
|
12086
|
-
"state": {},
|
|
12087
|
-
"options": {},
|
|
12088
|
-
"envVars": [],
|
|
12089
|
-
"examples": [
|
|
12090
|
-
{
|
|
12091
|
-
"language": "ts",
|
|
12092
|
-
"code": "const el = container.client('elevenlabs')\nawait el.connect()\nconst voices = await el.listVoices()\nconst audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data"
|
|
12093
|
-
}
|
|
12094
|
-
],
|
|
12095
|
-
"types": {
|
|
12096
|
-
"SynthesizeOptions": {
|
|
12097
|
-
"description": "",
|
|
12098
|
-
"properties": {
|
|
12099
|
-
"voiceId": {
|
|
12100
|
-
"type": "string",
|
|
12101
|
-
"description": "",
|
|
12102
|
-
"optional": true
|
|
12103
|
-
},
|
|
12104
|
-
"modelId": {
|
|
12105
|
-
"type": "string",
|
|
12106
|
-
"description": "",
|
|
12107
|
-
"optional": true
|
|
12108
|
-
},
|
|
12109
|
-
"outputFormat": {
|
|
12110
|
-
"type": "string",
|
|
12111
|
-
"description": "",
|
|
12112
|
-
"optional": true
|
|
12113
|
-
},
|
|
12114
|
-
"voiceSettings": {
|
|
12115
|
-
"type": "ElevenLabsVoiceSettings",
|
|
12116
|
-
"description": "",
|
|
12117
|
-
"optional": true
|
|
12118
|
-
},
|
|
12119
|
-
"disableCache": {
|
|
12120
|
-
"type": "boolean",
|
|
12121
|
-
"description": "",
|
|
12122
|
-
"optional": true
|
|
12123
|
-
}
|
|
12124
|
-
}
|
|
12125
|
-
},
|
|
12126
|
-
"ElevenLabsVoiceSettings": {
|
|
12127
|
-
"description": "",
|
|
12128
|
-
"properties": {
|
|
12129
|
-
"stability": {
|
|
12130
|
-
"type": "number",
|
|
12131
|
-
"description": "",
|
|
12132
|
-
"optional": true
|
|
12133
|
-
},
|
|
12134
|
-
"similarityBoost": {
|
|
12135
|
-
"type": "number",
|
|
12136
|
-
"description": "",
|
|
12137
|
-
"optional": true
|
|
12138
|
-
},
|
|
12139
|
-
"style": {
|
|
12140
|
-
"type": "number",
|
|
12141
|
-
"description": "",
|
|
12142
|
-
"optional": true
|
|
12143
|
-
},
|
|
12144
|
-
"speed": {
|
|
12145
|
-
"type": "number",
|
|
12146
|
-
"description": "",
|
|
12147
|
-
"optional": true
|
|
12148
|
-
},
|
|
12149
|
-
"useSpeakerBoost": {
|
|
12150
|
-
"type": "boolean",
|
|
12151
|
-
"description": "",
|
|
12152
|
-
"optional": true
|
|
12153
|
-
}
|
|
12154
|
-
}
|
|
12155
|
-
}
|
|
12156
|
-
}
|
|
12157
|
-
});
|
|
12158
|
-
|
|
12159
11895
|
setBuildTimeData('clients.comfyui', {
|
|
12160
11896
|
"id": "clients.comfyui",
|
|
12161
11897
|
"description": "ComfyUI client — execute Stable Diffusion workflows via the ComfyUI API. Connects to a ComfyUI instance to queue prompts, track execution via WebSocket or polling, and download generated images. Supports both UI-format and API-format workflows with automatic conversion.",
|
|
@@ -12264,136 +12000,383 @@ setBuildTimeData('clients.comfyui', {
|
|
|
12264
12000
|
],
|
|
12265
12001
|
"returns": "Promise<any>"
|
|
12266
12002
|
},
|
|
12267
|
-
"viewImage": {
|
|
12268
|
-
"description": "Download a generated image from ComfyUI as a Buffer.",
|
|
12003
|
+
"viewImage": {
|
|
12004
|
+
"description": "Download a generated image from ComfyUI as a Buffer.",
|
|
12005
|
+
"parameters": {
|
|
12006
|
+
"filename": {
|
|
12007
|
+
"type": "string",
|
|
12008
|
+
"description": "The image filename"
|
|
12009
|
+
},
|
|
12010
|
+
"subfolder": {
|
|
12011
|
+
"type": "any",
|
|
12012
|
+
"description": "Subfolder within the output directory"
|
|
12013
|
+
},
|
|
12014
|
+
"type": {
|
|
12015
|
+
"type": "any",
|
|
12016
|
+
"description": "Image type ('output', 'input', 'temp')"
|
|
12017
|
+
}
|
|
12018
|
+
},
|
|
12019
|
+
"required": [
|
|
12020
|
+
"filename"
|
|
12021
|
+
],
|
|
12022
|
+
"returns": "Promise<Buffer>"
|
|
12023
|
+
},
|
|
12024
|
+
"connectWs": {
|
|
12025
|
+
"description": "Open a WebSocket connection to ComfyUI for real-time execution tracking. Events emitted: `execution_start`, `executing`, `progress`, `executed`, `execution_cached`, `execution_error`, `execution_complete`.",
|
|
12026
|
+
"parameters": {},
|
|
12027
|
+
"required": [],
|
|
12028
|
+
"returns": "Promise<void>"
|
|
12029
|
+
},
|
|
12030
|
+
"disconnectWs": {
|
|
12031
|
+
"description": "Close the WebSocket connection.",
|
|
12032
|
+
"parameters": {},
|
|
12033
|
+
"required": [],
|
|
12034
|
+
"returns": "void"
|
|
12035
|
+
},
|
|
12036
|
+
"toApiFormat": {
|
|
12037
|
+
"description": "Convert a UI-format workflow to the API format that /prompt expects. Requires a running ComfyUI instance to fetch `object_info` so we can map positional `widgets_values` to their named input fields. If the workflow is already in API format, it's returned as-is.",
|
|
12038
|
+
"parameters": {
|
|
12039
|
+
"workflow": {
|
|
12040
|
+
"type": "Record<string, any>",
|
|
12041
|
+
"description": "Parameter workflow"
|
|
12042
|
+
}
|
|
12043
|
+
},
|
|
12044
|
+
"required": [
|
|
12045
|
+
"workflow"
|
|
12046
|
+
],
|
|
12047
|
+
"returns": "Promise<Record<string, any>>"
|
|
12048
|
+
},
|
|
12049
|
+
"runWorkflow": {
|
|
12050
|
+
"description": "Run a ComfyUI workflow with optional runtime input overrides. Inputs can be provided in two forms: **Direct node mapping** (when no `inputMap` in options): ``` { '3': { seed: 42 }, '6': { text: 'a cat' } } ``` **Named inputs** (when `inputMap` is provided in options): ``` inputs: { positive_prompt: 'a cat', seed: 42 } options.inputMap: { positive_prompt: { nodeId: '6', field: 'text' }, seed: { nodeId: '3', field: 'seed' } } ```",
|
|
12051
|
+
"parameters": {
|
|
12052
|
+
"workflow": {
|
|
12053
|
+
"type": "Record<string, any>",
|
|
12054
|
+
"description": "Parameter workflow"
|
|
12055
|
+
},
|
|
12056
|
+
"inputs": {
|
|
12057
|
+
"type": "Record<string, any>",
|
|
12058
|
+
"description": "Parameter inputs"
|
|
12059
|
+
},
|
|
12060
|
+
"options": {
|
|
12061
|
+
"type": "WorkflowRunOptions",
|
|
12062
|
+
"description": "Parameter options",
|
|
12063
|
+
"properties": {
|
|
12064
|
+
"poll": {
|
|
12065
|
+
"type": "boolean",
|
|
12066
|
+
"description": "Use polling instead of WebSocket for tracking execution"
|
|
12067
|
+
},
|
|
12068
|
+
"pollInterval": {
|
|
12069
|
+
"type": "number",
|
|
12070
|
+
"description": "Polling interval in ms (default 1000)"
|
|
12071
|
+
},
|
|
12072
|
+
"inputMap": {
|
|
12073
|
+
"type": "InputMapping",
|
|
12074
|
+
"description": "Named input mapping: semantic name -> { nodeId, field }"
|
|
12075
|
+
},
|
|
12076
|
+
"outputDir": {
|
|
12077
|
+
"type": "string",
|
|
12078
|
+
"description": "If provided, output images are downloaded to this directory"
|
|
12079
|
+
}
|
|
12080
|
+
}
|
|
12081
|
+
}
|
|
12082
|
+
},
|
|
12083
|
+
"required": [
|
|
12084
|
+
"workflow"
|
|
12085
|
+
],
|
|
12086
|
+
"returns": "Promise<WorkflowResult>"
|
|
12087
|
+
}
|
|
12088
|
+
},
|
|
12089
|
+
"getters": {
|
|
12090
|
+
"clientId": {
|
|
12091
|
+
"description": "The unique client ID used for WebSocket session tracking.",
|
|
12092
|
+
"returns": "string"
|
|
12093
|
+
},
|
|
12094
|
+
"wsURL": {
|
|
12095
|
+
"description": "The WebSocket URL derived from baseURL or overridden via options.",
|
|
12096
|
+
"returns": "string"
|
|
12097
|
+
}
|
|
12098
|
+
},
|
|
12099
|
+
"events": {
|
|
12100
|
+
"execution_start": {
|
|
12101
|
+
"name": "execution_start",
|
|
12102
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12103
|
+
"arguments": {}
|
|
12104
|
+
},
|
|
12105
|
+
"execution_complete": {
|
|
12106
|
+
"name": "execution_complete",
|
|
12107
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12108
|
+
"arguments": {}
|
|
12109
|
+
},
|
|
12110
|
+
"executing": {
|
|
12111
|
+
"name": "executing",
|
|
12112
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12113
|
+
"arguments": {}
|
|
12114
|
+
},
|
|
12115
|
+
"progress": {
|
|
12116
|
+
"name": "progress",
|
|
12117
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12118
|
+
"arguments": {}
|
|
12119
|
+
},
|
|
12120
|
+
"executed": {
|
|
12121
|
+
"name": "executed",
|
|
12122
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12123
|
+
"arguments": {}
|
|
12124
|
+
},
|
|
12125
|
+
"execution_cached": {
|
|
12126
|
+
"name": "execution_cached",
|
|
12127
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12128
|
+
"arguments": {}
|
|
12129
|
+
},
|
|
12130
|
+
"execution_error": {
|
|
12131
|
+
"name": "execution_error",
|
|
12132
|
+
"description": "Event emitted by ComfyUIClient",
|
|
12133
|
+
"arguments": {}
|
|
12134
|
+
}
|
|
12135
|
+
},
|
|
12136
|
+
"state": {},
|
|
12137
|
+
"options": {},
|
|
12138
|
+
"envVars": [],
|
|
12139
|
+
"examples": [
|
|
12140
|
+
{
|
|
12141
|
+
"language": "ts",
|
|
12142
|
+
"code": "const comfy = container.client('comfyui', { baseURL: 'http://localhost:8188' })\nconst result = await comfy.runWorkflow(workflow, {\n '6': { text: 'a beautiful sunset' }\n})\nconsole.log(result.images)"
|
|
12143
|
+
}
|
|
12144
|
+
],
|
|
12145
|
+
"types": {
|
|
12146
|
+
"WorkflowRunOptions": {
|
|
12147
|
+
"description": "",
|
|
12148
|
+
"properties": {
|
|
12149
|
+
"poll": {
|
|
12150
|
+
"type": "boolean",
|
|
12151
|
+
"description": "Use polling instead of WebSocket for tracking execution",
|
|
12152
|
+
"optional": true
|
|
12153
|
+
},
|
|
12154
|
+
"pollInterval": {
|
|
12155
|
+
"type": "number",
|
|
12156
|
+
"description": "Polling interval in ms (default 1000)",
|
|
12157
|
+
"optional": true
|
|
12158
|
+
},
|
|
12159
|
+
"inputMap": {
|
|
12160
|
+
"type": "InputMapping",
|
|
12161
|
+
"description": "Named input mapping: semantic name -> { nodeId, field }",
|
|
12162
|
+
"optional": true
|
|
12163
|
+
},
|
|
12164
|
+
"outputDir": {
|
|
12165
|
+
"type": "string",
|
|
12166
|
+
"description": "If provided, output images are downloaded to this directory",
|
|
12167
|
+
"optional": true
|
|
12168
|
+
}
|
|
12169
|
+
}
|
|
12170
|
+
},
|
|
12171
|
+
"WorkflowResult": {
|
|
12172
|
+
"description": "",
|
|
12173
|
+
"properties": {
|
|
12174
|
+
"promptId": {
|
|
12175
|
+
"type": "string",
|
|
12176
|
+
"description": ""
|
|
12177
|
+
},
|
|
12178
|
+
"outputs": {
|
|
12179
|
+
"type": "Record<string, any>",
|
|
12180
|
+
"description": ""
|
|
12181
|
+
},
|
|
12182
|
+
"images": {
|
|
12183
|
+
"type": "Array<{ filename: string; subfolder: string; type: string; localPath?: string }>",
|
|
12184
|
+
"description": "",
|
|
12185
|
+
"optional": true
|
|
12186
|
+
}
|
|
12187
|
+
}
|
|
12188
|
+
}
|
|
12189
|
+
}
|
|
12190
|
+
});
|
|
12191
|
+
|
|
12192
|
+
setBuildTimeData('clients.elevenlabs', {
|
|
12193
|
+
"id": "clients.elevenlabs",
|
|
12194
|
+
"description": "ElevenLabs client — text-to-speech synthesis via the ElevenLabs REST API. Provides methods for listing voices, listing models, and generating speech audio. Audio is returned as a Buffer; use `say()` for a convenience method that writes to disk.",
|
|
12195
|
+
"shortcut": "clients.elevenlabs",
|
|
12196
|
+
"className": "ElevenLabsClient",
|
|
12197
|
+
"methods": {
|
|
12198
|
+
"beforeRequest": {
|
|
12199
|
+
"description": "Inject the xi-api-key header before each request.",
|
|
12200
|
+
"parameters": {},
|
|
12201
|
+
"required": [],
|
|
12202
|
+
"returns": "void"
|
|
12203
|
+
},
|
|
12204
|
+
"connect": {
|
|
12205
|
+
"description": "Validate the API key by listing available models.",
|
|
12206
|
+
"parameters": {},
|
|
12207
|
+
"required": [],
|
|
12208
|
+
"returns": "Promise<this>",
|
|
12209
|
+
"examples": [
|
|
12210
|
+
{
|
|
12211
|
+
"language": "ts",
|
|
12212
|
+
"code": "await el.connect()"
|
|
12213
|
+
}
|
|
12214
|
+
]
|
|
12215
|
+
},
|
|
12216
|
+
"listVoices": {
|
|
12217
|
+
"description": "List available voices with optional search and filtering.",
|
|
12218
|
+
"parameters": {
|
|
12219
|
+
"options": {
|
|
12220
|
+
"type": "{\n search?: string\n category?: string\n voice_type?: string\n page_size?: number\n next_page_token?: string\n }",
|
|
12221
|
+
"description": "Query parameters for filtering voices"
|
|
12222
|
+
}
|
|
12223
|
+
},
|
|
12224
|
+
"required": [],
|
|
12225
|
+
"returns": "Promise<any>",
|
|
12226
|
+
"examples": [
|
|
12227
|
+
{
|
|
12228
|
+
"language": "ts",
|
|
12229
|
+
"code": "const voices = await el.listVoices()\nconst premade = await el.listVoices({ category: 'premade' })"
|
|
12230
|
+
}
|
|
12231
|
+
]
|
|
12232
|
+
},
|
|
12233
|
+
"getVoice": {
|
|
12234
|
+
"description": "Get details for a single voice.",
|
|
12269
12235
|
"parameters": {
|
|
12270
|
-
"
|
|
12236
|
+
"voiceId": {
|
|
12271
12237
|
"type": "string",
|
|
12272
|
-
"description": "The
|
|
12273
|
-
},
|
|
12274
|
-
"subfolder": {
|
|
12275
|
-
"type": "any",
|
|
12276
|
-
"description": "Subfolder within the output directory"
|
|
12277
|
-
},
|
|
12278
|
-
"type": {
|
|
12279
|
-
"type": "any",
|
|
12280
|
-
"description": "Image type ('output', 'input', 'temp')"
|
|
12238
|
+
"description": "The voice ID to look up"
|
|
12281
12239
|
}
|
|
12282
12240
|
},
|
|
12283
12241
|
"required": [
|
|
12284
|
-
"
|
|
12242
|
+
"voiceId"
|
|
12285
12243
|
],
|
|
12286
|
-
"returns": "Promise<
|
|
12287
|
-
|
|
12288
|
-
|
|
12289
|
-
|
|
12290
|
-
|
|
12291
|
-
|
|
12292
|
-
|
|
12244
|
+
"returns": "Promise<any>",
|
|
12245
|
+
"examples": [
|
|
12246
|
+
{
|
|
12247
|
+
"language": "ts",
|
|
12248
|
+
"code": "const voice = await el.getVoice('21m00Tcm4TlvDq8ikWAM')\nconsole.log(voice.name, voice.settings)"
|
|
12249
|
+
}
|
|
12250
|
+
]
|
|
12293
12251
|
},
|
|
12294
|
-
"
|
|
12295
|
-
"description": "
|
|
12252
|
+
"listModels": {
|
|
12253
|
+
"description": "List available TTS models.",
|
|
12296
12254
|
"parameters": {},
|
|
12297
12255
|
"required": [],
|
|
12298
|
-
"returns": "
|
|
12256
|
+
"returns": "Promise<any[]>",
|
|
12257
|
+
"examples": [
|
|
12258
|
+
{
|
|
12259
|
+
"language": "ts",
|
|
12260
|
+
"code": "const models = await el.listModels()\nconsole.log(models.map(m => m.model_id))"
|
|
12261
|
+
}
|
|
12262
|
+
]
|
|
12299
12263
|
},
|
|
12300
|
-
"
|
|
12301
|
-
"description": "
|
|
12264
|
+
"synthesize": {
|
|
12265
|
+
"description": "Synthesize speech from text, returning audio as a Buffer.",
|
|
12302
12266
|
"parameters": {
|
|
12303
|
-
"
|
|
12304
|
-
"type": "
|
|
12305
|
-
"description": "
|
|
12267
|
+
"text": {
|
|
12268
|
+
"type": "string",
|
|
12269
|
+
"description": "The text to convert to speech"
|
|
12270
|
+
},
|
|
12271
|
+
"options": {
|
|
12272
|
+
"type": "SynthesizeOptions",
|
|
12273
|
+
"description": "Voice, model, format, and voice settings overrides",
|
|
12274
|
+
"properties": {
|
|
12275
|
+
"voiceId": {
|
|
12276
|
+
"type": "string",
|
|
12277
|
+
"description": ""
|
|
12278
|
+
},
|
|
12279
|
+
"modelId": {
|
|
12280
|
+
"type": "string",
|
|
12281
|
+
"description": ""
|
|
12282
|
+
},
|
|
12283
|
+
"outputFormat": {
|
|
12284
|
+
"type": "string",
|
|
12285
|
+
"description": ""
|
|
12286
|
+
},
|
|
12287
|
+
"voiceSettings": {
|
|
12288
|
+
"type": "ElevenLabsVoiceSettings",
|
|
12289
|
+
"description": ""
|
|
12290
|
+
},
|
|
12291
|
+
"disableCache": {
|
|
12292
|
+
"type": "boolean",
|
|
12293
|
+
"description": ""
|
|
12294
|
+
}
|
|
12295
|
+
}
|
|
12306
12296
|
}
|
|
12307
12297
|
},
|
|
12308
12298
|
"required": [
|
|
12309
|
-
"
|
|
12299
|
+
"text"
|
|
12310
12300
|
],
|
|
12311
|
-
"returns": "Promise<
|
|
12301
|
+
"returns": "Promise<Buffer>",
|
|
12302
|
+
"examples": [
|
|
12303
|
+
{
|
|
12304
|
+
"language": "ts",
|
|
12305
|
+
"code": "const audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data\n\nconst custom = await el.synthesize('Hello', {\n voiceId: '21m00Tcm4TlvDq8ikWAM',\n voiceSettings: { stability: 0.5, similarityBoost: 0.8 }\n})"
|
|
12306
|
+
}
|
|
12307
|
+
]
|
|
12312
12308
|
},
|
|
12313
|
-
"
|
|
12314
|
-
"description": "
|
|
12309
|
+
"say": {
|
|
12310
|
+
"description": "Synthesize speech and write the audio to a file.",
|
|
12315
12311
|
"parameters": {
|
|
12316
|
-
"
|
|
12317
|
-
"type": "
|
|
12318
|
-
"description": "
|
|
12312
|
+
"text": {
|
|
12313
|
+
"type": "string",
|
|
12314
|
+
"description": "The text to convert to speech"
|
|
12319
12315
|
},
|
|
12320
|
-
"
|
|
12321
|
-
"type": "
|
|
12322
|
-
"description": "
|
|
12316
|
+
"outputPath": {
|
|
12317
|
+
"type": "string",
|
|
12318
|
+
"description": "File path to write the audio to"
|
|
12323
12319
|
},
|
|
12324
12320
|
"options": {
|
|
12325
|
-
"type": "
|
|
12326
|
-
"description": "
|
|
12321
|
+
"type": "SynthesizeOptions",
|
|
12322
|
+
"description": "Voice, model, format, and voice settings overrides",
|
|
12327
12323
|
"properties": {
|
|
12328
|
-
"
|
|
12329
|
-
"type": "
|
|
12330
|
-
"description": "
|
|
12331
|
-
},
|
|
12332
|
-
"pollInterval": {
|
|
12333
|
-
"type": "number",
|
|
12334
|
-
"description": "Polling interval in ms (default 1000)"
|
|
12324
|
+
"voiceId": {
|
|
12325
|
+
"type": "string",
|
|
12326
|
+
"description": ""
|
|
12335
12327
|
},
|
|
12336
|
-
"
|
|
12337
|
-
"type": "
|
|
12338
|
-
"description": "
|
|
12328
|
+
"modelId": {
|
|
12329
|
+
"type": "string",
|
|
12330
|
+
"description": ""
|
|
12339
12331
|
},
|
|
12340
|
-
"
|
|
12332
|
+
"outputFormat": {
|
|
12341
12333
|
"type": "string",
|
|
12342
|
-
"description": "
|
|
12334
|
+
"description": ""
|
|
12335
|
+
},
|
|
12336
|
+
"voiceSettings": {
|
|
12337
|
+
"type": "ElevenLabsVoiceSettings",
|
|
12338
|
+
"description": ""
|
|
12339
|
+
},
|
|
12340
|
+
"disableCache": {
|
|
12341
|
+
"type": "boolean",
|
|
12342
|
+
"description": ""
|
|
12343
12343
|
}
|
|
12344
12344
|
}
|
|
12345
12345
|
}
|
|
12346
12346
|
},
|
|
12347
12347
|
"required": [
|
|
12348
|
-
"
|
|
12348
|
+
"text",
|
|
12349
|
+
"outputPath"
|
|
12349
12350
|
],
|
|
12350
|
-
"returns": "Promise<
|
|
12351
|
+
"returns": "Promise<string>",
|
|
12352
|
+
"examples": [
|
|
12353
|
+
{
|
|
12354
|
+
"language": "ts",
|
|
12355
|
+
"code": "const path = await el.say('Hello world', './hello.mp3')\nconsole.log(`Audio saved to ${path}`)"
|
|
12356
|
+
}
|
|
12357
|
+
]
|
|
12351
12358
|
}
|
|
12352
12359
|
},
|
|
12353
12360
|
"getters": {
|
|
12354
|
-
"
|
|
12355
|
-
"description": "The
|
|
12356
|
-
"returns": "string"
|
|
12357
|
-
},
|
|
12358
|
-
"wsURL": {
|
|
12359
|
-
"description": "The WebSocket URL derived from baseURL or overridden via options.",
|
|
12361
|
+
"apiKey": {
|
|
12362
|
+
"description": "The resolved API key from options or environment.",
|
|
12360
12363
|
"returns": "string"
|
|
12361
12364
|
}
|
|
12362
12365
|
},
|
|
12363
12366
|
"events": {
|
|
12364
|
-
"
|
|
12365
|
-
"name": "
|
|
12366
|
-
"description": "Event emitted by
|
|
12367
|
-
"arguments": {}
|
|
12368
|
-
},
|
|
12369
|
-
"execution_complete": {
|
|
12370
|
-
"name": "execution_complete",
|
|
12371
|
-
"description": "Event emitted by ComfyUIClient",
|
|
12372
|
-
"arguments": {}
|
|
12373
|
-
},
|
|
12374
|
-
"executing": {
|
|
12375
|
-
"name": "executing",
|
|
12376
|
-
"description": "Event emitted by ComfyUIClient",
|
|
12377
|
-
"arguments": {}
|
|
12378
|
-
},
|
|
12379
|
-
"progress": {
|
|
12380
|
-
"name": "progress",
|
|
12381
|
-
"description": "Event emitted by ComfyUIClient",
|
|
12382
|
-
"arguments": {}
|
|
12383
|
-
},
|
|
12384
|
-
"executed": {
|
|
12385
|
-
"name": "executed",
|
|
12386
|
-
"description": "Event emitted by ComfyUIClient",
|
|
12367
|
+
"failure": {
|
|
12368
|
+
"name": "failure",
|
|
12369
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
12387
12370
|
"arguments": {}
|
|
12388
12371
|
},
|
|
12389
|
-
"
|
|
12390
|
-
"name": "
|
|
12391
|
-
"description": "Event emitted by
|
|
12372
|
+
"voices": {
|
|
12373
|
+
"name": "voices",
|
|
12374
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
12392
12375
|
"arguments": {}
|
|
12393
12376
|
},
|
|
12394
|
-
"
|
|
12395
|
-
"name": "
|
|
12396
|
-
"description": "Event emitted by
|
|
12377
|
+
"speech": {
|
|
12378
|
+
"name": "speech",
|
|
12379
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
12397
12380
|
"arguments": {}
|
|
12398
12381
|
}
|
|
12399
12382
|
},
|
|
@@ -12403,48 +12386,65 @@ setBuildTimeData('clients.comfyui', {
|
|
|
12403
12386
|
"examples": [
|
|
12404
12387
|
{
|
|
12405
12388
|
"language": "ts",
|
|
12406
|
-
"code": "const
|
|
12389
|
+
"code": "const el = container.client('elevenlabs')\nawait el.connect()\nconst voices = await el.listVoices()\nconst audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data"
|
|
12407
12390
|
}
|
|
12408
12391
|
],
|
|
12409
12392
|
"types": {
|
|
12410
|
-
"
|
|
12393
|
+
"SynthesizeOptions": {
|
|
12411
12394
|
"description": "",
|
|
12412
12395
|
"properties": {
|
|
12413
|
-
"
|
|
12414
|
-
"type": "
|
|
12415
|
-
"description": "
|
|
12396
|
+
"voiceId": {
|
|
12397
|
+
"type": "string",
|
|
12398
|
+
"description": "",
|
|
12416
12399
|
"optional": true
|
|
12417
12400
|
},
|
|
12418
|
-
"
|
|
12419
|
-
"type": "
|
|
12420
|
-
"description": "
|
|
12401
|
+
"modelId": {
|
|
12402
|
+
"type": "string",
|
|
12403
|
+
"description": "",
|
|
12421
12404
|
"optional": true
|
|
12422
12405
|
},
|
|
12423
|
-
"
|
|
12424
|
-
"type": "
|
|
12425
|
-
"description": "
|
|
12406
|
+
"outputFormat": {
|
|
12407
|
+
"type": "string",
|
|
12408
|
+
"description": "",
|
|
12426
12409
|
"optional": true
|
|
12427
12410
|
},
|
|
12428
|
-
"
|
|
12429
|
-
"type": "
|
|
12430
|
-
"description": "
|
|
12411
|
+
"voiceSettings": {
|
|
12412
|
+
"type": "ElevenLabsVoiceSettings",
|
|
12413
|
+
"description": "",
|
|
12414
|
+
"optional": true
|
|
12415
|
+
},
|
|
12416
|
+
"disableCache": {
|
|
12417
|
+
"type": "boolean",
|
|
12418
|
+
"description": "",
|
|
12431
12419
|
"optional": true
|
|
12432
12420
|
}
|
|
12433
12421
|
}
|
|
12434
12422
|
},
|
|
12435
|
-
"
|
|
12423
|
+
"ElevenLabsVoiceSettings": {
|
|
12436
12424
|
"description": "",
|
|
12437
12425
|
"properties": {
|
|
12438
|
-
"
|
|
12439
|
-
"type": "
|
|
12440
|
-
"description": ""
|
|
12426
|
+
"stability": {
|
|
12427
|
+
"type": "number",
|
|
12428
|
+
"description": "",
|
|
12429
|
+
"optional": true
|
|
12441
12430
|
},
|
|
12442
|
-
"
|
|
12443
|
-
"type": "
|
|
12444
|
-
"description": ""
|
|
12431
|
+
"similarityBoost": {
|
|
12432
|
+
"type": "number",
|
|
12433
|
+
"description": "",
|
|
12434
|
+
"optional": true
|
|
12435
|
+
},
|
|
12436
|
+
"style": {
|
|
12437
|
+
"type": "number",
|
|
12438
|
+
"description": "",
|
|
12439
|
+
"optional": true
|
|
12440
|
+
},
|
|
12441
|
+
"speed": {
|
|
12442
|
+
"type": "number",
|
|
12443
|
+
"description": "",
|
|
12444
|
+
"optional": true
|
|
12445
12445
|
},
|
|
12446
|
-
"
|
|
12447
|
-
"type": "
|
|
12446
|
+
"useSpeakerBoost": {
|
|
12447
|
+
"type": "boolean",
|
|
12448
12448
|
"description": "",
|
|
12449
12449
|
"optional": true
|
|
12450
12450
|
}
|
|
@@ -28621,549 +28621,186 @@ export const introspectionData = [
|
|
|
28621
28621
|
"type": "string",
|
|
28622
28622
|
"description": "Optional operation name when the mutation contains multiple operations"
|
|
28623
28623
|
}
|
|
28624
|
-
},
|
|
28625
|
-
"required": [
|
|
28626
|
-
"mutation"
|
|
28627
|
-
],
|
|
28628
|
-
"returns": "Promise<R>"
|
|
28629
|
-
}
|
|
28630
|
-
},
|
|
28631
|
-
"getters": {
|
|
28632
|
-
"endpoint": {
|
|
28633
|
-
"description": "The GraphQL endpoint path. Defaults to '/graphql'.",
|
|
28634
|
-
"returns": "any"
|
|
28635
|
-
}
|
|
28636
|
-
},
|
|
28637
|
-
"events": {
|
|
28638
|
-
"graphqlError": {
|
|
28639
|
-
"name": "graphqlError",
|
|
28640
|
-
"description": "Event emitted by GraphClient",
|
|
28641
|
-
"arguments": {}
|
|
28642
|
-
},
|
|
28643
|
-
"failure": {
|
|
28644
|
-
"name": "failure",
|
|
28645
|
-
"description": "Event emitted by GraphClient",
|
|
28646
|
-
"arguments": {}
|
|
28647
|
-
}
|
|
28648
|
-
},
|
|
28649
|
-
"state": {},
|
|
28650
|
-
"options": {},
|
|
28651
|
-
"envVars": [],
|
|
28652
|
-
"examples": [
|
|
28653
|
-
{
|
|
28654
|
-
"language": "ts",
|
|
28655
|
-
"code": "const gql = container.client('graph', { baseURL: 'https://api.example.com' })\nconst data = await gql.query(`{ users { id name } }`)\nawait gql.mutate(`mutation($name: String!) { createUser(name: $name) { id } }`, { name: 'Alice' })"
|
|
28656
|
-
}
|
|
28657
|
-
]
|
|
28658
|
-
},
|
|
28659
|
-
{
|
|
28660
|
-
"id": "clients.rest",
|
|
28661
|
-
"description": "HTTP REST client built on top of axios. Provides convenience methods for GET, POST, PUT, PATCH, and DELETE requests with automatic JSON handling, configurable base URL, and error event emission.",
|
|
28662
|
-
"shortcut": "clients.rest",
|
|
28663
|
-
"className": "RestClient",
|
|
28664
|
-
"methods": {
|
|
28665
|
-
"beforeRequest": {
|
|
28666
|
-
"description": "",
|
|
28667
|
-
"parameters": {},
|
|
28668
|
-
"required": [],
|
|
28669
|
-
"returns": "Promise<void>"
|
|
28670
|
-
},
|
|
28671
|
-
"patch": {
|
|
28672
|
-
"description": "Send a PATCH request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28673
|
-
"parameters": {
|
|
28674
|
-
"url": {
|
|
28675
|
-
"type": "string",
|
|
28676
|
-
"description": "Request path relative to baseURL"
|
|
28677
|
-
},
|
|
28678
|
-
"data": {
|
|
28679
|
-
"type": "any",
|
|
28680
|
-
"description": "Request body"
|
|
28681
|
-
},
|
|
28682
|
-
"options": {
|
|
28683
|
-
"type": "AxiosRequestConfig",
|
|
28684
|
-
"description": "Additional axios request config"
|
|
28685
|
-
}
|
|
28686
|
-
},
|
|
28687
|
-
"required": [
|
|
28688
|
-
"url"
|
|
28689
|
-
],
|
|
28690
|
-
"returns": "Promise<any>"
|
|
28691
|
-
},
|
|
28692
|
-
"put": {
|
|
28693
|
-
"description": "Send a PUT request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28694
|
-
"parameters": {
|
|
28695
|
-
"url": {
|
|
28696
|
-
"type": "string",
|
|
28697
|
-
"description": "Request path relative to baseURL"
|
|
28698
|
-
},
|
|
28699
|
-
"data": {
|
|
28700
|
-
"type": "any",
|
|
28701
|
-
"description": "Request body"
|
|
28702
|
-
},
|
|
28703
|
-
"options": {
|
|
28704
|
-
"type": "AxiosRequestConfig",
|
|
28705
|
-
"description": "Additional axios request config"
|
|
28706
|
-
}
|
|
28707
|
-
},
|
|
28708
|
-
"required": [
|
|
28709
|
-
"url"
|
|
28710
|
-
],
|
|
28711
|
-
"returns": "Promise<any>"
|
|
28712
|
-
},
|
|
28713
|
-
"post": {
|
|
28714
|
-
"description": "Send a POST request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28715
|
-
"parameters": {
|
|
28716
|
-
"url": {
|
|
28717
|
-
"type": "string",
|
|
28718
|
-
"description": "Request path relative to baseURL"
|
|
28719
|
-
},
|
|
28720
|
-
"data": {
|
|
28721
|
-
"type": "any",
|
|
28722
|
-
"description": "Request body"
|
|
28723
|
-
},
|
|
28724
|
-
"options": {
|
|
28725
|
-
"type": "AxiosRequestConfig",
|
|
28726
|
-
"description": "Additional axios request config"
|
|
28727
|
-
}
|
|
28728
|
-
},
|
|
28729
|
-
"required": [
|
|
28730
|
-
"url"
|
|
28731
|
-
],
|
|
28732
|
-
"returns": "Promise<any>"
|
|
28733
|
-
},
|
|
28734
|
-
"delete": {
|
|
28735
|
-
"description": "Send a DELETE request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28736
|
-
"parameters": {
|
|
28737
|
-
"url": {
|
|
28738
|
-
"type": "string",
|
|
28739
|
-
"description": "Request path relative to baseURL"
|
|
28740
|
-
},
|
|
28741
|
-
"params": {
|
|
28742
|
-
"type": "any",
|
|
28743
|
-
"description": "Query parameters"
|
|
28744
|
-
},
|
|
28745
|
-
"options": {
|
|
28746
|
-
"type": "AxiosRequestConfig",
|
|
28747
|
-
"description": "Additional axios request config"
|
|
28748
|
-
}
|
|
28749
|
-
},
|
|
28750
|
-
"required": [
|
|
28751
|
-
"url"
|
|
28752
|
-
],
|
|
28753
|
-
"returns": "Promise<any>"
|
|
28754
|
-
},
|
|
28755
|
-
"get": {
|
|
28756
|
-
"description": "Send a GET request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28757
|
-
"parameters": {
|
|
28758
|
-
"url": {
|
|
28759
|
-
"type": "string",
|
|
28760
|
-
"description": "Request path relative to baseURL"
|
|
28761
|
-
},
|
|
28762
|
-
"params": {
|
|
28763
|
-
"type": "any",
|
|
28764
|
-
"description": "Query parameters"
|
|
28765
|
-
},
|
|
28766
|
-
"options": {
|
|
28767
|
-
"type": "AxiosRequestConfig",
|
|
28768
|
-
"description": "Additional axios request config"
|
|
28769
|
-
}
|
|
28770
|
-
},
|
|
28771
|
-
"required": [
|
|
28772
|
-
"url"
|
|
28773
|
-
],
|
|
28774
|
-
"returns": "Promise<any>"
|
|
28775
|
-
},
|
|
28776
|
-
"handleError": {
|
|
28777
|
-
"description": "Handle an axios error by emitting 'failure' and returning the error as JSON.",
|
|
28778
|
-
"parameters": {
|
|
28779
|
-
"error": {
|
|
28780
|
-
"type": "AxiosError",
|
|
28781
|
-
"description": "Parameter error"
|
|
28782
|
-
}
|
|
28783
|
-
},
|
|
28784
|
-
"required": [
|
|
28785
|
-
"error"
|
|
28786
|
-
],
|
|
28787
|
-
"returns": "Promise<object>"
|
|
28788
|
-
}
|
|
28789
|
-
},
|
|
28790
|
-
"getters": {
|
|
28791
|
-
"useJSON": {
|
|
28792
|
-
"description": "Whether JSON content-type headers should be set automatically.",
|
|
28793
|
-
"returns": "any"
|
|
28794
|
-
},
|
|
28795
|
-
"baseURL": {
|
|
28796
|
-
"description": "",
|
|
28797
|
-
"returns": "any"
|
|
28798
|
-
}
|
|
28799
|
-
},
|
|
28800
|
-
"events": {
|
|
28801
|
-
"failure": {
|
|
28802
|
-
"name": "failure",
|
|
28803
|
-
"description": "Event emitted by RestClient",
|
|
28804
|
-
"arguments": {}
|
|
28805
|
-
}
|
|
28806
|
-
},
|
|
28807
|
-
"state": {},
|
|
28808
|
-
"options": {},
|
|
28809
|
-
"envVars": [],
|
|
28810
|
-
"examples": [
|
|
28811
|
-
{
|
|
28812
|
-
"language": "ts",
|
|
28813
|
-
"code": "const api = container.client('rest', { baseURL: 'https://api.example.com', json: true })\nconst users = await api.get('/users')\nawait api.post('/users', { name: 'Alice' })"
|
|
28814
|
-
}
|
|
28815
|
-
]
|
|
28816
|
-
},
|
|
28817
|
-
{
|
|
28818
|
-
"id": "clients.websocket",
|
|
28819
|
-
"description": "WebSocketClient helper",
|
|
28820
|
-
"shortcut": "clients.websocket",
|
|
28821
|
-
"className": "WebSocketClient",
|
|
28822
|
-
"methods": {
|
|
28823
|
-
"connect": {
|
|
28824
|
-
"description": "Establish a WebSocket connection to the configured baseURL. Wires all raw WebSocket events (open, message, close, error) to the Helper event bus and updates connection state accordingly. Resolves once the connection is open; rejects on error.",
|
|
28825
|
-
"parameters": {},
|
|
28826
|
-
"required": [],
|
|
28827
|
-
"returns": "Promise<this>"
|
|
28828
|
-
},
|
|
28829
|
-
"send": {
|
|
28830
|
-
"description": "Send data over the WebSocket connection. Automatically JSON-serializes the payload. If not currently connected, attempts to connect first.",
|
|
28831
|
-
"parameters": {
|
|
28832
|
-
"data": {
|
|
28833
|
-
"type": "any",
|
|
28834
|
-
"description": "The data to send (will be JSON.stringify'd)"
|
|
28835
|
-
}
|
|
28836
|
-
},
|
|
28837
|
-
"required": [
|
|
28838
|
-
"data"
|
|
28839
|
-
],
|
|
28840
|
-
"returns": "Promise<void>"
|
|
28841
|
-
},
|
|
28842
|
-
"ask": {
|
|
28843
|
-
"description": "Send a request and wait for a correlated response. The message is sent with a unique `requestId`; the remote side is expected to reply with a message containing `replyTo` set to that same ID.",
|
|
28844
|
-
"parameters": {
|
|
28845
|
-
"type": {
|
|
28846
|
-
"type": "string",
|
|
28847
|
-
"description": "A string identifying the request type"
|
|
28848
|
-
},
|
|
28849
|
-
"data": {
|
|
28850
|
-
"type": "any",
|
|
28851
|
-
"description": "Optional payload to include with the request"
|
|
28852
|
-
},
|
|
28853
|
-
"timeout": {
|
|
28854
|
-
"type": "any",
|
|
28855
|
-
"description": "How long to wait for a response (default 10 000 ms)"
|
|
28856
|
-
}
|
|
28857
|
-
},
|
|
28858
|
-
"required": [
|
|
28859
|
-
"type"
|
|
28860
|
-
],
|
|
28861
|
-
"returns": "Promise<R>",
|
|
28862
|
-
"examples": [
|
|
28863
|
-
{
|
|
28864
|
-
"language": "ts",
|
|
28865
|
-
"code": "const result = await ws.ask('getUser', { id: 42 })"
|
|
28866
|
-
}
|
|
28867
|
-
]
|
|
28868
|
-
},
|
|
28869
|
-
"disconnect": {
|
|
28870
|
-
"description": "Gracefully close the WebSocket connection. Suppresses auto-reconnect and updates connection state to disconnected.",
|
|
28871
|
-
"parameters": {},
|
|
28872
|
-
"required": [],
|
|
28873
|
-
"returns": "Promise<this>"
|
|
28624
|
+
},
|
|
28625
|
+
"required": [
|
|
28626
|
+
"mutation"
|
|
28627
|
+
],
|
|
28628
|
+
"returns": "Promise<R>"
|
|
28874
28629
|
}
|
|
28875
28630
|
},
|
|
28876
28631
|
"getters": {
|
|
28877
|
-
"
|
|
28878
|
-
"description": "
|
|
28632
|
+
"endpoint": {
|
|
28633
|
+
"description": "The GraphQL endpoint path. Defaults to '/graphql'.",
|
|
28879
28634
|
"returns": "any"
|
|
28880
28635
|
}
|
|
28881
28636
|
},
|
|
28882
28637
|
"events": {
|
|
28883
|
-
"
|
|
28884
|
-
"name": "
|
|
28885
|
-
"description": "Event emitted by
|
|
28886
|
-
"arguments": {}
|
|
28887
|
-
},
|
|
28888
|
-
"error": {
|
|
28889
|
-
"name": "error",
|
|
28890
|
-
"description": "Event emitted by WebSocketClient",
|
|
28891
|
-
"arguments": {}
|
|
28892
|
-
},
|
|
28893
|
-
"message": {
|
|
28894
|
-
"name": "message",
|
|
28895
|
-
"description": "Event emitted by WebSocketClient",
|
|
28896
|
-
"arguments": {}
|
|
28897
|
-
},
|
|
28898
|
-
"close": {
|
|
28899
|
-
"name": "close",
|
|
28900
|
-
"description": "Event emitted by WebSocketClient",
|
|
28638
|
+
"graphqlError": {
|
|
28639
|
+
"name": "graphqlError",
|
|
28640
|
+
"description": "Event emitted by GraphClient",
|
|
28901
28641
|
"arguments": {}
|
|
28902
28642
|
},
|
|
28903
|
-
"
|
|
28904
|
-
"name": "
|
|
28905
|
-
"description": "Event emitted by
|
|
28643
|
+
"failure": {
|
|
28644
|
+
"name": "failure",
|
|
28645
|
+
"description": "Event emitted by GraphClient",
|
|
28906
28646
|
"arguments": {}
|
|
28907
28647
|
}
|
|
28908
28648
|
},
|
|
28909
28649
|
"state": {},
|
|
28910
28650
|
"options": {},
|
|
28911
|
-
"envVars": []
|
|
28651
|
+
"envVars": [],
|
|
28652
|
+
"examples": [
|
|
28653
|
+
{
|
|
28654
|
+
"language": "ts",
|
|
28655
|
+
"code": "const gql = container.client('graph', { baseURL: 'https://api.example.com' })\nconst data = await gql.query(`{ users { id name } }`)\nawait gql.mutate(`mutation($name: String!) { createUser(name: $name) { id } }`, { name: 'Alice' })"
|
|
28656
|
+
}
|
|
28657
|
+
]
|
|
28912
28658
|
},
|
|
28913
28659
|
{
|
|
28914
|
-
"id": "clients.
|
|
28915
|
-
"description": "
|
|
28916
|
-
"shortcut": "clients.
|
|
28917
|
-
"className": "
|
|
28660
|
+
"id": "clients.rest",
|
|
28661
|
+
"description": "HTTP REST client built on top of axios. Provides convenience methods for GET, POST, PUT, PATCH, and DELETE requests with automatic JSON handling, configurable base URL, and error event emission.",
|
|
28662
|
+
"shortcut": "clients.rest",
|
|
28663
|
+
"className": "RestClient",
|
|
28918
28664
|
"methods": {
|
|
28919
|
-
"
|
|
28920
|
-
"description": "
|
|
28665
|
+
"beforeRequest": {
|
|
28666
|
+
"description": "",
|
|
28921
28667
|
"parameters": {},
|
|
28922
28668
|
"required": [],
|
|
28923
|
-
"returns": "Promise<
|
|
28924
|
-
"examples": [
|
|
28925
|
-
{
|
|
28926
|
-
"language": "ts",
|
|
28927
|
-
"code": "await openai.connect()"
|
|
28928
|
-
}
|
|
28929
|
-
]
|
|
28669
|
+
"returns": "Promise<void>"
|
|
28930
28670
|
},
|
|
28931
|
-
"
|
|
28932
|
-
"description": "
|
|
28671
|
+
"patch": {
|
|
28672
|
+
"description": "Send a PATCH request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28933
28673
|
"parameters": {
|
|
28934
|
-
"
|
|
28935
|
-
"type": "
|
|
28936
|
-
"description": "
|
|
28674
|
+
"url": {
|
|
28675
|
+
"type": "string",
|
|
28676
|
+
"description": "Request path relative to baseURL"
|
|
28937
28677
|
},
|
|
28938
|
-
"
|
|
28939
|
-
"type": "
|
|
28940
|
-
"description": "
|
|
28941
|
-
}
|
|
28942
|
-
},
|
|
28943
|
-
"required": [
|
|
28944
|
-
"messages"
|
|
28945
|
-
],
|
|
28946
|
-
"returns": "Promise<OpenAI.Chat.Completions.ChatCompletion>",
|
|
28947
|
-
"examples": [
|
|
28948
|
-
{
|
|
28949
|
-
"language": "ts",
|
|
28950
|
-
"code": "const response = await openai.createChatCompletion([\n { role: 'system', content: 'You are a helpful assistant.' },\n { role: 'user', content: 'Hello!' }\n])\nconsole.log(response.choices[0]?.message?.content)"
|
|
28951
|
-
}
|
|
28952
|
-
]
|
|
28953
|
-
},
|
|
28954
|
-
"createResponse": {
|
|
28955
|
-
"description": "Create a response using the Responses API.",
|
|
28956
|
-
"parameters": {
|
|
28957
|
-
"input": {
|
|
28958
|
-
"type": "OpenAI.Responses.ResponseInput | string",
|
|
28959
|
-
"description": "The input prompt or message array"
|
|
28678
|
+
"data": {
|
|
28679
|
+
"type": "any",
|
|
28680
|
+
"description": "Request body"
|
|
28960
28681
|
},
|
|
28961
28682
|
"options": {
|
|
28962
|
-
"type": "
|
|
28963
|
-
"description": "Additional
|
|
28683
|
+
"type": "AxiosRequestConfig",
|
|
28684
|
+
"description": "Additional axios request config"
|
|
28964
28685
|
}
|
|
28965
28686
|
},
|
|
28966
28687
|
"required": [
|
|
28967
|
-
"
|
|
28688
|
+
"url"
|
|
28968
28689
|
],
|
|
28969
|
-
"returns": "Promise<
|
|
28970
|
-
"examples": [
|
|
28971
|
-
{
|
|
28972
|
-
"language": "ts",
|
|
28973
|
-
"code": "const response = await openai.createResponse('Explain quantum computing')"
|
|
28974
|
-
}
|
|
28975
|
-
]
|
|
28690
|
+
"returns": "Promise<any>"
|
|
28976
28691
|
},
|
|
28977
|
-
"
|
|
28978
|
-
"description": "
|
|
28692
|
+
"put": {
|
|
28693
|
+
"description": "Send a PUT request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
28979
28694
|
"parameters": {
|
|
28980
|
-
"
|
|
28981
|
-
"type": "
|
|
28982
|
-
"description": "
|
|
28695
|
+
"url": {
|
|
28696
|
+
"type": "string",
|
|
28697
|
+
"description": "Request path relative to baseURL"
|
|
28698
|
+
},
|
|
28699
|
+
"data": {
|
|
28700
|
+
"type": "any",
|
|
28701
|
+
"description": "Request body"
|
|
28983
28702
|
},
|
|
28984
28703
|
"options": {
|
|
28985
|
-
"type": "
|
|
28986
|
-
"description": "Additional
|
|
28704
|
+
"type": "AxiosRequestConfig",
|
|
28705
|
+
"description": "Additional axios request config"
|
|
28987
28706
|
}
|
|
28988
28707
|
},
|
|
28989
28708
|
"required": [
|
|
28990
|
-
"
|
|
28709
|
+
"url"
|
|
28991
28710
|
],
|
|
28992
|
-
"returns": "Promise<
|
|
28993
|
-
"examples": [
|
|
28994
|
-
{
|
|
28995
|
-
"language": "ts",
|
|
28996
|
-
"code": "const stream = await openai.streamResponse('Write a poem')\nfor await (const event of stream) {\n if (event.type === 'response.output_text.delta') {\n process.stdout.write(event.delta)\n }\n}"
|
|
28997
|
-
}
|
|
28998
|
-
]
|
|
28711
|
+
"returns": "Promise<any>"
|
|
28999
28712
|
},
|
|
29000
|
-
"
|
|
29001
|
-
"description": "
|
|
28713
|
+
"post": {
|
|
28714
|
+
"description": "Send a POST request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
29002
28715
|
"parameters": {
|
|
29003
|
-
"
|
|
28716
|
+
"url": {
|
|
29004
28717
|
"type": "string",
|
|
29005
|
-
"description": "
|
|
28718
|
+
"description": "Request path relative to baseURL"
|
|
29006
28719
|
},
|
|
29007
|
-
"
|
|
29008
|
-
"type": "
|
|
29009
|
-
"description": "
|
|
29010
|
-
}
|
|
29011
|
-
},
|
|
29012
|
-
"required": [
|
|
29013
|
-
"prompt"
|
|
29014
|
-
],
|
|
29015
|
-
"returns": "Promise<OpenAI.Completions.Completion>",
|
|
29016
|
-
"examples": [
|
|
29017
|
-
{
|
|
29018
|
-
"language": "ts",
|
|
29019
|
-
"code": "const response = await openai.createCompletion('Once upon a time')"
|
|
29020
|
-
}
|
|
29021
|
-
]
|
|
29022
|
-
},
|
|
29023
|
-
"createEmbedding": {
|
|
29024
|
-
"description": "Create text embeddings for semantic search or similarity comparisons.",
|
|
29025
|
-
"parameters": {
|
|
29026
|
-
"input": {
|
|
29027
|
-
"type": "string | string[]",
|
|
29028
|
-
"description": "A string or array of strings to embed"
|
|
28720
|
+
"data": {
|
|
28721
|
+
"type": "any",
|
|
28722
|
+
"description": "Request body"
|
|
29029
28723
|
},
|
|
29030
28724
|
"options": {
|
|
29031
|
-
"type": "
|
|
29032
|
-
"description": "Additional
|
|
28725
|
+
"type": "AxiosRequestConfig",
|
|
28726
|
+
"description": "Additional axios request config"
|
|
29033
28727
|
}
|
|
29034
28728
|
},
|
|
29035
28729
|
"required": [
|
|
29036
|
-
"
|
|
28730
|
+
"url"
|
|
29037
28731
|
],
|
|
29038
|
-
"returns": "Promise<
|
|
29039
|
-
"examples": [
|
|
29040
|
-
{
|
|
29041
|
-
"language": "ts",
|
|
29042
|
-
"code": "const response = await openai.createEmbedding('Hello world')\nconsole.log(response.data[0].embedding.length)"
|
|
29043
|
-
}
|
|
29044
|
-
]
|
|
28732
|
+
"returns": "Promise<any>"
|
|
29045
28733
|
},
|
|
29046
|
-
"
|
|
29047
|
-
"description": "
|
|
28734
|
+
"delete": {
|
|
28735
|
+
"description": "Send a DELETE request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
29048
28736
|
"parameters": {
|
|
29049
|
-
"
|
|
28737
|
+
"url": {
|
|
29050
28738
|
"type": "string",
|
|
29051
|
-
"description": "
|
|
28739
|
+
"description": "Request path relative to baseURL"
|
|
28740
|
+
},
|
|
28741
|
+
"params": {
|
|
28742
|
+
"type": "any",
|
|
28743
|
+
"description": "Query parameters"
|
|
29052
28744
|
},
|
|
29053
28745
|
"options": {
|
|
29054
|
-
"type": "
|
|
29055
|
-
"description": "Additional
|
|
28746
|
+
"type": "AxiosRequestConfig",
|
|
28747
|
+
"description": "Additional axios request config"
|
|
29056
28748
|
}
|
|
29057
28749
|
},
|
|
29058
28750
|
"required": [
|
|
29059
|
-
"
|
|
28751
|
+
"url"
|
|
29060
28752
|
],
|
|
29061
|
-
"returns": "Promise<
|
|
29062
|
-
"examples": [
|
|
29063
|
-
{
|
|
29064
|
-
"language": "ts",
|
|
29065
|
-
"code": "const response = await openai.createImage('A sunset over mountains')\nconsole.log(response.data[0].url)"
|
|
29066
|
-
}
|
|
29067
|
-
]
|
|
29068
|
-
},
|
|
29069
|
-
"listModels": {
|
|
29070
|
-
"description": "List all available models.",
|
|
29071
|
-
"parameters": {},
|
|
29072
|
-
"required": [],
|
|
29073
|
-
"returns": "Promise<OpenAI.Models.ModelsPage>",
|
|
29074
|
-
"examples": [
|
|
29075
|
-
{
|
|
29076
|
-
"language": "ts",
|
|
29077
|
-
"code": "const models = await openai.listModels()"
|
|
29078
|
-
}
|
|
29079
|
-
]
|
|
28753
|
+
"returns": "Promise<any>"
|
|
29080
28754
|
},
|
|
29081
|
-
"
|
|
29082
|
-
"description": "
|
|
28755
|
+
"get": {
|
|
28756
|
+
"description": "Send a GET request. Returns the parsed response body directly (not an axios Response wrapper). On HTTP errors, returns the error as JSON instead of throwing.",
|
|
29083
28757
|
"parameters": {
|
|
29084
|
-
"
|
|
28758
|
+
"url": {
|
|
29085
28759
|
"type": "string",
|
|
29086
|
-
"description": "
|
|
28760
|
+
"description": "Request path relative to baseURL"
|
|
29087
28761
|
},
|
|
29088
|
-
"
|
|
29089
|
-
"type": "
|
|
29090
|
-
"description": "
|
|
29091
|
-
}
|
|
29092
|
-
},
|
|
29093
|
-
"required": [
|
|
29094
|
-
"question"
|
|
29095
|
-
],
|
|
29096
|
-
"returns": "Promise<string>",
|
|
29097
|
-
"examples": [
|
|
29098
|
-
{
|
|
29099
|
-
"language": "ts",
|
|
29100
|
-
"code": "const answer = await openai.ask('What is 2 + 2?')\nconsole.log(answer) // '4'"
|
|
29101
|
-
}
|
|
29102
|
-
]
|
|
29103
|
-
},
|
|
29104
|
-
"chat": {
|
|
29105
|
-
"description": "Send a multi-turn conversation and get a text response. Convenience wrapper around `createChatCompletion` that returns just the text.",
|
|
29106
|
-
"parameters": {
|
|
29107
|
-
"messages": {
|
|
29108
|
-
"type": "OpenAI.Chat.Completions.ChatCompletionMessageParam[]",
|
|
29109
|
-
"description": "Array of chat messages"
|
|
28762
|
+
"params": {
|
|
28763
|
+
"type": "any",
|
|
28764
|
+
"description": "Query parameters"
|
|
29110
28765
|
},
|
|
29111
28766
|
"options": {
|
|
29112
|
-
"type": "
|
|
29113
|
-
"description": "Additional
|
|
28767
|
+
"type": "AxiosRequestConfig",
|
|
28768
|
+
"description": "Additional axios request config"
|
|
29114
28769
|
}
|
|
29115
28770
|
},
|
|
29116
28771
|
"required": [
|
|
29117
|
-
"
|
|
28772
|
+
"url"
|
|
29118
28773
|
],
|
|
29119
|
-
"returns": "Promise<
|
|
29120
|
-
|
|
29121
|
-
|
|
29122
|
-
|
|
29123
|
-
|
|
28774
|
+
"returns": "Promise<any>"
|
|
28775
|
+
},
|
|
28776
|
+
"handleError": {
|
|
28777
|
+
"description": "Handle an axios error by emitting 'failure' and returning the error as JSON.",
|
|
28778
|
+
"parameters": {
|
|
28779
|
+
"error": {
|
|
28780
|
+
"type": "AxiosError",
|
|
28781
|
+
"description": "Parameter error"
|
|
29124
28782
|
}
|
|
29125
|
-
|
|
28783
|
+
},
|
|
28784
|
+
"required": [
|
|
28785
|
+
"error"
|
|
28786
|
+
],
|
|
28787
|
+
"returns": "Promise<object>"
|
|
29126
28788
|
}
|
|
29127
28789
|
},
|
|
29128
28790
|
"getters": {
|
|
29129
|
-
"
|
|
29130
|
-
"description": "
|
|
29131
|
-
"returns": "
|
|
28791
|
+
"useJSON": {
|
|
28792
|
+
"description": "Whether JSON content-type headers should be set automatically.",
|
|
28793
|
+
"returns": "any"
|
|
29132
28794
|
},
|
|
29133
|
-
"
|
|
29134
|
-
"description": "
|
|
29135
|
-
"returns": "
|
|
28795
|
+
"baseURL": {
|
|
28796
|
+
"description": "",
|
|
28797
|
+
"returns": "any"
|
|
29136
28798
|
}
|
|
29137
28799
|
},
|
|
29138
28800
|
"events": {
|
|
29139
|
-
"connected": {
|
|
29140
|
-
"name": "connected",
|
|
29141
|
-
"description": "Event emitted by OpenAIClient",
|
|
29142
|
-
"arguments": {}
|
|
29143
|
-
},
|
|
29144
28801
|
"failure": {
|
|
29145
28802
|
"name": "failure",
|
|
29146
|
-
"description": "Event emitted by
|
|
29147
|
-
"arguments": {}
|
|
29148
|
-
},
|
|
29149
|
-
"completion": {
|
|
29150
|
-
"name": "completion",
|
|
29151
|
-
"description": "Event emitted by OpenAIClient",
|
|
29152
|
-
"arguments": {}
|
|
29153
|
-
},
|
|
29154
|
-
"embedding": {
|
|
29155
|
-
"name": "embedding",
|
|
29156
|
-
"description": "Event emitted by OpenAIClient",
|
|
29157
|
-
"arguments": {}
|
|
29158
|
-
},
|
|
29159
|
-
"image": {
|
|
29160
|
-
"name": "image",
|
|
29161
|
-
"description": "Event emitted by OpenAIClient",
|
|
29162
|
-
"arguments": {}
|
|
29163
|
-
},
|
|
29164
|
-
"models": {
|
|
29165
|
-
"name": "models",
|
|
29166
|
-
"description": "Event emitted by OpenAIClient",
|
|
28803
|
+
"description": "Event emitted by RestClient",
|
|
29167
28804
|
"arguments": {}
|
|
29168
28805
|
}
|
|
29169
28806
|
},
|
|
@@ -29173,393 +28810,360 @@ export const introspectionData = [
|
|
|
29173
28810
|
"examples": [
|
|
29174
28811
|
{
|
|
29175
28812
|
"language": "ts",
|
|
29176
|
-
"code": "const
|
|
28813
|
+
"code": "const api = container.client('rest', { baseURL: 'https://api.example.com', json: true })\nconst users = await api.get('/users')\nawait api.post('/users', { name: 'Alice' })"
|
|
29177
28814
|
}
|
|
29178
28815
|
]
|
|
29179
28816
|
},
|
|
29180
28817
|
{
|
|
29181
|
-
"id": "clients.
|
|
29182
|
-
"description": "
|
|
29183
|
-
"shortcut": "clients.
|
|
29184
|
-
"className": "
|
|
28818
|
+
"id": "clients.websocket",
|
|
28819
|
+
"description": "WebSocketClient helper",
|
|
28820
|
+
"shortcut": "clients.websocket",
|
|
28821
|
+
"className": "WebSocketClient",
|
|
29185
28822
|
"methods": {
|
|
29186
|
-
"
|
|
29187
|
-
"description": "
|
|
29188
|
-
"parameters": {
|
|
29189
|
-
|
|
29190
|
-
|
|
29191
|
-
"description": "The table or view name to query"
|
|
29192
|
-
}
|
|
29193
|
-
},
|
|
29194
|
-
"required": [
|
|
29195
|
-
"table"
|
|
29196
|
-
],
|
|
29197
|
-
"returns": "void"
|
|
28823
|
+
"connect": {
|
|
28824
|
+
"description": "Establish a WebSocket connection to the configured baseURL. Wires all raw WebSocket events (open, message, close, error) to the Helper event bus and updates connection state accordingly. Resolves once the connection is open; rejects on error.",
|
|
28825
|
+
"parameters": {},
|
|
28826
|
+
"required": [],
|
|
28827
|
+
"returns": "Promise<this>"
|
|
29198
28828
|
},
|
|
29199
|
-
"
|
|
29200
|
-
"description": "
|
|
28829
|
+
"send": {
|
|
28830
|
+
"description": "Send data over the WebSocket connection. Automatically JSON-serializes the payload. If not currently connected, attempts to connect first.",
|
|
29201
28831
|
"parameters": {
|
|
29202
|
-
"
|
|
29203
|
-
"type": "
|
|
29204
|
-
"description": "The
|
|
29205
|
-
},
|
|
29206
|
-
"params": {
|
|
29207
|
-
"type": "Record<string, unknown>",
|
|
29208
|
-
"description": "Arguments to pass to the function"
|
|
29209
|
-
},
|
|
29210
|
-
"options": {
|
|
29211
|
-
"type": "{ head?: boolean; get?: boolean; count?: \"exact\" | \"planned\" | \"estimated\" }",
|
|
29212
|
-
"description": "Optional settings (head, get, count)"
|
|
28832
|
+
"data": {
|
|
28833
|
+
"type": "any",
|
|
28834
|
+
"description": "The data to send (will be JSON.stringify'd)"
|
|
29213
28835
|
}
|
|
29214
28836
|
},
|
|
29215
28837
|
"required": [
|
|
29216
|
-
"
|
|
28838
|
+
"data"
|
|
29217
28839
|
],
|
|
29218
|
-
"returns": "void"
|
|
28840
|
+
"returns": "Promise<void>"
|
|
29219
28841
|
},
|
|
29220
|
-
"
|
|
29221
|
-
"description": "
|
|
28842
|
+
"ask": {
|
|
28843
|
+
"description": "Send a request and wait for a correlated response. The message is sent with a unique `requestId`; the remote side is expected to reply with a message containing `replyTo` set to that same ID.",
|
|
29222
28844
|
"parameters": {
|
|
29223
|
-
"
|
|
28845
|
+
"type": {
|
|
29224
28846
|
"type": "string",
|
|
29225
|
-
"description": "
|
|
28847
|
+
"description": "A string identifying the request type"
|
|
29226
28848
|
},
|
|
29227
|
-
"
|
|
29228
|
-
"type": "
|
|
29229
|
-
"description": "
|
|
29230
|
-
}
|
|
29231
|
-
},
|
|
29232
|
-
"required": [
|
|
29233
|
-
"email",
|
|
29234
|
-
"password"
|
|
29235
|
-
],
|
|
29236
|
-
"returns": "void"
|
|
29237
|
-
},
|
|
29238
|
-
"signUp": {
|
|
29239
|
-
"description": "Create a new user account with email and password.",
|
|
29240
|
-
"parameters": {
|
|
29241
|
-
"email": {
|
|
29242
|
-
"type": "string",
|
|
29243
|
-
"description": "Parameter email"
|
|
28849
|
+
"data": {
|
|
28850
|
+
"type": "any",
|
|
28851
|
+
"description": "Optional payload to include with the request"
|
|
29244
28852
|
},
|
|
29245
|
-
"
|
|
29246
|
-
"type": "
|
|
29247
|
-
"description": "
|
|
28853
|
+
"timeout": {
|
|
28854
|
+
"type": "any",
|
|
28855
|
+
"description": "How long to wait for a response (default 10 000 ms)"
|
|
29248
28856
|
}
|
|
29249
28857
|
},
|
|
29250
28858
|
"required": [
|
|
29251
|
-
"
|
|
29252
|
-
"password"
|
|
28859
|
+
"type"
|
|
29253
28860
|
],
|
|
29254
|
-
"returns": "
|
|
28861
|
+
"returns": "Promise<R>",
|
|
28862
|
+
"examples": [
|
|
28863
|
+
{
|
|
28864
|
+
"language": "ts",
|
|
28865
|
+
"code": "const result = await ws.ask('getUser', { id: 42 })"
|
|
28866
|
+
}
|
|
28867
|
+
]
|
|
29255
28868
|
},
|
|
29256
|
-
"
|
|
29257
|
-
"description": "
|
|
28869
|
+
"disconnect": {
|
|
28870
|
+
"description": "Gracefully close the WebSocket connection. Suppresses auto-reconnect and updates connection state to disconnected.",
|
|
29258
28871
|
"parameters": {},
|
|
29259
28872
|
"required": [],
|
|
29260
|
-
"returns": "
|
|
28873
|
+
"returns": "Promise<this>"
|
|
28874
|
+
}
|
|
28875
|
+
},
|
|
28876
|
+
"getters": {
|
|
28877
|
+
"hasError": {
|
|
28878
|
+
"description": "Whether the client is in an error state.",
|
|
28879
|
+
"returns": "any"
|
|
28880
|
+
}
|
|
28881
|
+
},
|
|
28882
|
+
"events": {
|
|
28883
|
+
"open": {
|
|
28884
|
+
"name": "open",
|
|
28885
|
+
"description": "Event emitted by WebSocketClient",
|
|
28886
|
+
"arguments": {}
|
|
29261
28887
|
},
|
|
29262
|
-
"
|
|
29263
|
-
"
|
|
29264
|
-
"
|
|
29265
|
-
"
|
|
29266
|
-
"returns": "void"
|
|
28888
|
+
"error": {
|
|
28889
|
+
"name": "error",
|
|
28890
|
+
"description": "Event emitted by WebSocketClient",
|
|
28891
|
+
"arguments": {}
|
|
29267
28892
|
},
|
|
29268
|
-
"
|
|
29269
|
-
"
|
|
28893
|
+
"message": {
|
|
28894
|
+
"name": "message",
|
|
28895
|
+
"description": "Event emitted by WebSocketClient",
|
|
28896
|
+
"arguments": {}
|
|
28897
|
+
},
|
|
28898
|
+
"close": {
|
|
28899
|
+
"name": "close",
|
|
28900
|
+
"description": "Event emitted by WebSocketClient",
|
|
28901
|
+
"arguments": {}
|
|
28902
|
+
},
|
|
28903
|
+
"reconnecting": {
|
|
28904
|
+
"name": "reconnecting",
|
|
28905
|
+
"description": "Event emitted by WebSocketClient",
|
|
28906
|
+
"arguments": {}
|
|
28907
|
+
}
|
|
28908
|
+
},
|
|
28909
|
+
"state": {},
|
|
28910
|
+
"options": {},
|
|
28911
|
+
"envVars": []
|
|
28912
|
+
},
|
|
28913
|
+
{
|
|
28914
|
+
"id": "clients.openai",
|
|
28915
|
+
"description": "OpenAI client — wraps the OpenAI SDK for chat completions, responses API, embeddings, and image generation. Provides convenience methods for common operations while tracking token usage and request counts. Supports both the Chat Completions API and the newer Responses API.",
|
|
28916
|
+
"shortcut": "clients.openai",
|
|
28917
|
+
"className": "OpenAIClient",
|
|
28918
|
+
"methods": {
|
|
28919
|
+
"connect": {
|
|
28920
|
+
"description": "Test the API connection by listing models.",
|
|
29270
28921
|
"parameters": {},
|
|
29271
28922
|
"required": [],
|
|
29272
|
-
"returns": "
|
|
28923
|
+
"returns": "Promise<this>",
|
|
28924
|
+
"examples": [
|
|
28925
|
+
{
|
|
28926
|
+
"language": "ts",
|
|
28927
|
+
"code": "await openai.connect()"
|
|
28928
|
+
}
|
|
28929
|
+
]
|
|
29273
28930
|
},
|
|
29274
|
-
"
|
|
29275
|
-
"description": "
|
|
28931
|
+
"createChatCompletion": {
|
|
28932
|
+
"description": "Create a chat completion using the Chat Completions API.",
|
|
29276
28933
|
"parameters": {
|
|
29277
|
-
"
|
|
29278
|
-
"type": "
|
|
29279
|
-
"description": "
|
|
28934
|
+
"messages": {
|
|
28935
|
+
"type": "OpenAI.Chat.Completions.ChatCompletionMessageParam[]",
|
|
28936
|
+
"description": "Array of chat messages"
|
|
28937
|
+
},
|
|
28938
|
+
"options": {
|
|
28939
|
+
"type": "Partial<OpenAI.Chat.Completions.ChatCompletionCreateParams>",
|
|
28940
|
+
"description": "Additional parameters for the completion"
|
|
28941
|
+
}
|
|
28942
|
+
},
|
|
28943
|
+
"required": [
|
|
28944
|
+
"messages"
|
|
28945
|
+
],
|
|
28946
|
+
"returns": "Promise<OpenAI.Chat.Completions.ChatCompletion>",
|
|
28947
|
+
"examples": [
|
|
28948
|
+
{
|
|
28949
|
+
"language": "ts",
|
|
28950
|
+
"code": "const response = await openai.createChatCompletion([\n { role: 'system', content: 'You are a helpful assistant.' },\n { role: 'user', content: 'Hello!' }\n])\nconsole.log(response.choices[0]?.message?.content)"
|
|
28951
|
+
}
|
|
28952
|
+
]
|
|
28953
|
+
},
|
|
28954
|
+
"createResponse": {
|
|
28955
|
+
"description": "Create a response using the Responses API.",
|
|
28956
|
+
"parameters": {
|
|
28957
|
+
"input": {
|
|
28958
|
+
"type": "OpenAI.Responses.ResponseInput | string",
|
|
28959
|
+
"description": "The input prompt or message array"
|
|
29280
28960
|
},
|
|
29281
|
-
"
|
|
29282
|
-
"type": "
|
|
29283
|
-
"description": "
|
|
28961
|
+
"options": {
|
|
28962
|
+
"type": "Partial<OpenAI.Responses.ResponseCreateParamsNonStreaming>",
|
|
28963
|
+
"description": "Additional parameters for the response"
|
|
29284
28964
|
}
|
|
29285
28965
|
},
|
|
29286
28966
|
"required": [
|
|
29287
|
-
"
|
|
28967
|
+
"input"
|
|
29288
28968
|
],
|
|
29289
|
-
"returns": "
|
|
28969
|
+
"returns": "Promise<OpenAI.Responses.Response>",
|
|
28970
|
+
"examples": [
|
|
28971
|
+
{
|
|
28972
|
+
"language": "ts",
|
|
28973
|
+
"code": "const response = await openai.createResponse('Explain quantum computing')"
|
|
28974
|
+
}
|
|
28975
|
+
]
|
|
29290
28976
|
},
|
|
29291
|
-
"
|
|
29292
|
-
"description": "
|
|
28977
|
+
"streamResponse": {
|
|
28978
|
+
"description": "Stream a response using the Responses API.",
|
|
29293
28979
|
"parameters": {
|
|
29294
|
-
"
|
|
29295
|
-
"type": "string",
|
|
29296
|
-
"description": "
|
|
29297
|
-
},
|
|
29298
|
-
"table": {
|
|
29299
|
-
"type": "string",
|
|
29300
|
-
"description": "The table to listen to"
|
|
29301
|
-
},
|
|
29302
|
-
"callback": {
|
|
29303
|
-
"type": "(payload: any) => void",
|
|
29304
|
-
"description": "Called with the payload on each change"
|
|
28980
|
+
"input": {
|
|
28981
|
+
"type": "OpenAI.Responses.ResponseInput | string",
|
|
28982
|
+
"description": "The input prompt or message array"
|
|
29305
28983
|
},
|
|
29306
|
-
"
|
|
29307
|
-
"type": "
|
|
29308
|
-
"description": "
|
|
28984
|
+
"options": {
|
|
28985
|
+
"type": "Partial<OpenAI.Responses.ResponseCreateParamsStreaming>",
|
|
28986
|
+
"description": "Additional parameters for the streaming response"
|
|
29309
28987
|
}
|
|
29310
28988
|
},
|
|
29311
28989
|
"required": [
|
|
29312
|
-
"
|
|
29313
|
-
"table",
|
|
29314
|
-
"callback"
|
|
28990
|
+
"input"
|
|
29315
28991
|
],
|
|
29316
|
-
"returns": "
|
|
28992
|
+
"returns": "Promise<AsyncIterable<OpenAI.Responses.ResponseStreamEvent>>",
|
|
28993
|
+
"examples": [
|
|
28994
|
+
{
|
|
28995
|
+
"language": "ts",
|
|
28996
|
+
"code": "const stream = await openai.streamResponse('Write a poem')\nfor await (const event of stream) {\n if (event.type === 'response.output_text.delta') {\n process.stdout.write(event.delta)\n }\n}"
|
|
28997
|
+
}
|
|
28998
|
+
]
|
|
29317
28999
|
},
|
|
29318
|
-
"
|
|
29319
|
-
"description": "
|
|
29000
|
+
"createCompletion": {
|
|
29001
|
+
"description": "Create a legacy text completion.",
|
|
29320
29002
|
"parameters": {
|
|
29321
|
-
"
|
|
29003
|
+
"prompt": {
|
|
29322
29004
|
"type": "string",
|
|
29323
|
-
"description": "The
|
|
29005
|
+
"description": "The text prompt to complete"
|
|
29006
|
+
},
|
|
29007
|
+
"options": {
|
|
29008
|
+
"type": "Partial<OpenAI.Completions.CompletionCreateParams>",
|
|
29009
|
+
"description": "Additional parameters for the completion"
|
|
29324
29010
|
}
|
|
29325
29011
|
},
|
|
29326
29012
|
"required": [
|
|
29327
|
-
"
|
|
29013
|
+
"prompt"
|
|
29328
29014
|
],
|
|
29329
|
-
"returns": "
|
|
29330
|
-
},
|
|
29331
|
-
"unsubscribeAll": {
|
|
29332
|
-
"description": "Unsubscribe and remove all realtime channels.",
|
|
29333
|
-
"parameters": {},
|
|
29334
|
-
"required": [],
|
|
29335
|
-
"returns": "void"
|
|
29336
|
-
},
|
|
29337
|
-
"connect": {
|
|
29338
|
-
"description": "Connect is a no-op since the Supabase SDK initializes on construction. The client is ready to use immediately after creation.",
|
|
29339
|
-
"parameters": {},
|
|
29340
|
-
"required": [],
|
|
29341
|
-
"returns": "void"
|
|
29342
|
-
},
|
|
29343
|
-
"disconnect": {
|
|
29344
|
-
"description": "Disconnect by signing out and removing all realtime channels.",
|
|
29345
|
-
"parameters": {},
|
|
29346
|
-
"required": [],
|
|
29347
|
-
"returns": "void"
|
|
29348
|
-
}
|
|
29349
|
-
},
|
|
29350
|
-
"getters": {
|
|
29351
|
-
"sdk": {
|
|
29352
|
-
"description": "Returns the raw Supabase SDK client for full access to all SDK methods.",
|
|
29353
|
-
"returns": "SupabaseSDKClient<any, any>"
|
|
29354
|
-
},
|
|
29355
|
-
"storage": {
|
|
29356
|
-
"description": "Returns the Supabase Storage client for managing buckets and files.",
|
|
29357
|
-
"returns": "any"
|
|
29358
|
-
},
|
|
29359
|
-
"functions": {
|
|
29360
|
-
"description": "Returns the Supabase Functions client.",
|
|
29361
|
-
"returns": "any"
|
|
29362
|
-
}
|
|
29363
|
-
},
|
|
29364
|
-
"events": {},
|
|
29365
|
-
"state": {},
|
|
29366
|
-
"options": {},
|
|
29367
|
-
"envVars": [],
|
|
29368
|
-
"examples": [
|
|
29369
|
-
{
|
|
29370
|
-
"language": "ts",
|
|
29371
|
-
"code": "const supabase = container.client('supabase', {\n supabaseUrl: 'https://xyz.supabase.co',\n supabaseKey: 'your-anon-key',\n})\n\n// Query data\nconst { data } = await supabase.from('users').select('*')\n\n// Auth\nawait supabase.signInWithPassword('user@example.com', 'password')\n\n// Realtime\nsupabase.subscribe('changes', 'users', (payload) => {\n console.log('Change:', payload)\n})"
|
|
29372
|
-
}
|
|
29373
|
-
]
|
|
29374
|
-
},
|
|
29375
|
-
{
|
|
29376
|
-
"id": "clients.elevenlabs",
|
|
29377
|
-
"description": "ElevenLabs client — text-to-speech synthesis via the ElevenLabs REST API. Provides methods for listing voices, listing models, and generating speech audio. Audio is returned as a Buffer; use `say()` for a convenience method that writes to disk.",
|
|
29378
|
-
"shortcut": "clients.elevenlabs",
|
|
29379
|
-
"className": "ElevenLabsClient",
|
|
29380
|
-
"methods": {
|
|
29381
|
-
"beforeRequest": {
|
|
29382
|
-
"description": "Inject the xi-api-key header before each request.",
|
|
29383
|
-
"parameters": {},
|
|
29384
|
-
"required": [],
|
|
29385
|
-
"returns": "void"
|
|
29386
|
-
},
|
|
29387
|
-
"connect": {
|
|
29388
|
-
"description": "Validate the API key by listing available models.",
|
|
29389
|
-
"parameters": {},
|
|
29390
|
-
"required": [],
|
|
29391
|
-
"returns": "Promise<this>",
|
|
29015
|
+
"returns": "Promise<OpenAI.Completions.Completion>",
|
|
29392
29016
|
"examples": [
|
|
29393
29017
|
{
|
|
29394
29018
|
"language": "ts",
|
|
29395
|
-
"code": "await
|
|
29019
|
+
"code": "const response = await openai.createCompletion('Once upon a time')"
|
|
29396
29020
|
}
|
|
29397
29021
|
]
|
|
29398
29022
|
},
|
|
29399
|
-
"
|
|
29400
|
-
"description": "
|
|
29023
|
+
"createEmbedding": {
|
|
29024
|
+
"description": "Create text embeddings for semantic search or similarity comparisons.",
|
|
29401
29025
|
"parameters": {
|
|
29026
|
+
"input": {
|
|
29027
|
+
"type": "string | string[]",
|
|
29028
|
+
"description": "A string or array of strings to embed"
|
|
29029
|
+
},
|
|
29402
29030
|
"options": {
|
|
29403
|
-
"type": "
|
|
29404
|
-
"description": "
|
|
29031
|
+
"type": "Partial<OpenAI.Embeddings.EmbeddingCreateParams>",
|
|
29032
|
+
"description": "Additional parameters (model, etc.)"
|
|
29405
29033
|
}
|
|
29406
29034
|
},
|
|
29407
|
-
"required": [
|
|
29408
|
-
|
|
29035
|
+
"required": [
|
|
29036
|
+
"input"
|
|
29037
|
+
],
|
|
29038
|
+
"returns": "Promise<OpenAI.Embeddings.CreateEmbeddingResponse>",
|
|
29409
29039
|
"examples": [
|
|
29410
29040
|
{
|
|
29411
29041
|
"language": "ts",
|
|
29412
|
-
"code": "const
|
|
29042
|
+
"code": "const response = await openai.createEmbedding('Hello world')\nconsole.log(response.data[0].embedding.length)"
|
|
29413
29043
|
}
|
|
29414
29044
|
]
|
|
29415
29045
|
},
|
|
29416
|
-
"
|
|
29417
|
-
"description": "
|
|
29046
|
+
"createImage": {
|
|
29047
|
+
"description": "Generate an image from a text prompt using DALL-E.",
|
|
29418
29048
|
"parameters": {
|
|
29419
|
-
"
|
|
29049
|
+
"prompt": {
|
|
29420
29050
|
"type": "string",
|
|
29421
|
-
"description": "
|
|
29051
|
+
"description": "Description of the image to generate"
|
|
29052
|
+
},
|
|
29053
|
+
"options": {
|
|
29054
|
+
"type": "Partial<OpenAI.Images.ImageGenerateParams>",
|
|
29055
|
+
"description": "Additional parameters (size, n, etc.)"
|
|
29422
29056
|
}
|
|
29423
29057
|
},
|
|
29424
29058
|
"required": [
|
|
29425
|
-
"
|
|
29059
|
+
"prompt"
|
|
29426
29060
|
],
|
|
29427
|
-
"returns": "Promise<
|
|
29061
|
+
"returns": "Promise<OpenAI.Images.ImagesResponse>",
|
|
29428
29062
|
"examples": [
|
|
29429
29063
|
{
|
|
29430
29064
|
"language": "ts",
|
|
29431
|
-
"code": "const
|
|
29065
|
+
"code": "const response = await openai.createImage('A sunset over mountains')\nconsole.log(response.data[0].url)"
|
|
29432
29066
|
}
|
|
29433
29067
|
]
|
|
29434
29068
|
},
|
|
29435
29069
|
"listModels": {
|
|
29436
|
-
"description": "List available
|
|
29070
|
+
"description": "List all available models.",
|
|
29437
29071
|
"parameters": {},
|
|
29438
29072
|
"required": [],
|
|
29439
|
-
"returns": "Promise<
|
|
29073
|
+
"returns": "Promise<OpenAI.Models.ModelsPage>",
|
|
29440
29074
|
"examples": [
|
|
29441
29075
|
{
|
|
29442
29076
|
"language": "ts",
|
|
29443
|
-
"code": "const models = await
|
|
29077
|
+
"code": "const models = await openai.listModels()"
|
|
29444
29078
|
}
|
|
29445
29079
|
]
|
|
29446
29080
|
},
|
|
29447
|
-
"
|
|
29448
|
-
"description": "
|
|
29081
|
+
"ask": {
|
|
29082
|
+
"description": "Ask a single question and get a text response. Convenience wrapper around `createChatCompletion` for simple Q&A.",
|
|
29449
29083
|
"parameters": {
|
|
29450
|
-
"
|
|
29084
|
+
"question": {
|
|
29451
29085
|
"type": "string",
|
|
29452
|
-
"description": "The
|
|
29086
|
+
"description": "The question to ask"
|
|
29453
29087
|
},
|
|
29454
29088
|
"options": {
|
|
29455
|
-
"type": "
|
|
29456
|
-
"description": "
|
|
29457
|
-
"properties": {
|
|
29458
|
-
"voiceId": {
|
|
29459
|
-
"type": "string",
|
|
29460
|
-
"description": ""
|
|
29461
|
-
},
|
|
29462
|
-
"modelId": {
|
|
29463
|
-
"type": "string",
|
|
29464
|
-
"description": ""
|
|
29465
|
-
},
|
|
29466
|
-
"outputFormat": {
|
|
29467
|
-
"type": "string",
|
|
29468
|
-
"description": ""
|
|
29469
|
-
},
|
|
29470
|
-
"voiceSettings": {
|
|
29471
|
-
"type": "ElevenLabsVoiceSettings",
|
|
29472
|
-
"description": ""
|
|
29473
|
-
},
|
|
29474
|
-
"disableCache": {
|
|
29475
|
-
"type": "boolean",
|
|
29476
|
-
"description": ""
|
|
29477
|
-
}
|
|
29478
|
-
}
|
|
29089
|
+
"type": "Partial<OpenAI.Chat.Completions.ChatCompletionCreateParams>",
|
|
29090
|
+
"description": "Additional completion parameters"
|
|
29479
29091
|
}
|
|
29480
29092
|
},
|
|
29481
29093
|
"required": [
|
|
29482
|
-
"
|
|
29094
|
+
"question"
|
|
29483
29095
|
],
|
|
29484
|
-
"returns": "Promise<
|
|
29096
|
+
"returns": "Promise<string>",
|
|
29485
29097
|
"examples": [
|
|
29486
29098
|
{
|
|
29487
29099
|
"language": "ts",
|
|
29488
|
-
"code": "const
|
|
29100
|
+
"code": "const answer = await openai.ask('What is 2 + 2?')\nconsole.log(answer) // '4'"
|
|
29489
29101
|
}
|
|
29490
29102
|
]
|
|
29491
29103
|
},
|
|
29492
|
-
"
|
|
29493
|
-
"description": "
|
|
29494
|
-
"parameters": {
|
|
29495
|
-
"
|
|
29496
|
-
"type": "
|
|
29497
|
-
"description": "
|
|
29498
|
-
},
|
|
29499
|
-
"
|
|
29500
|
-
"type": "
|
|
29501
|
-
"description": "
|
|
29502
|
-
},
|
|
29503
|
-
"options": {
|
|
29504
|
-
"type": "SynthesizeOptions",
|
|
29505
|
-
"description": "Voice, model, format, and voice settings overrides",
|
|
29506
|
-
"properties": {
|
|
29507
|
-
"voiceId": {
|
|
29508
|
-
"type": "string",
|
|
29509
|
-
"description": ""
|
|
29510
|
-
},
|
|
29511
|
-
"modelId": {
|
|
29512
|
-
"type": "string",
|
|
29513
|
-
"description": ""
|
|
29514
|
-
},
|
|
29515
|
-
"outputFormat": {
|
|
29516
|
-
"type": "string",
|
|
29517
|
-
"description": ""
|
|
29518
|
-
},
|
|
29519
|
-
"voiceSettings": {
|
|
29520
|
-
"type": "ElevenLabsVoiceSettings",
|
|
29521
|
-
"description": ""
|
|
29522
|
-
},
|
|
29523
|
-
"disableCache": {
|
|
29524
|
-
"type": "boolean",
|
|
29525
|
-
"description": ""
|
|
29526
|
-
}
|
|
29527
|
-
}
|
|
29104
|
+
"chat": {
|
|
29105
|
+
"description": "Send a multi-turn conversation and get a text response. Convenience wrapper around `createChatCompletion` that returns just the text.",
|
|
29106
|
+
"parameters": {
|
|
29107
|
+
"messages": {
|
|
29108
|
+
"type": "OpenAI.Chat.Completions.ChatCompletionMessageParam[]",
|
|
29109
|
+
"description": "Array of chat messages"
|
|
29110
|
+
},
|
|
29111
|
+
"options": {
|
|
29112
|
+
"type": "Partial<OpenAI.Chat.Completions.ChatCompletionCreateParams>",
|
|
29113
|
+
"description": "Additional completion parameters"
|
|
29528
29114
|
}
|
|
29529
29115
|
},
|
|
29530
29116
|
"required": [
|
|
29531
|
-
"
|
|
29532
|
-
"outputPath"
|
|
29117
|
+
"messages"
|
|
29533
29118
|
],
|
|
29534
29119
|
"returns": "Promise<string>",
|
|
29535
29120
|
"examples": [
|
|
29536
29121
|
{
|
|
29537
29122
|
"language": "ts",
|
|
29538
|
-
"code": "const
|
|
29123
|
+
"code": "const reply = await openai.chat([\n { role: 'system', content: 'You are a pirate.' },\n { role: 'user', content: 'Hello!' }\n])"
|
|
29539
29124
|
}
|
|
29540
29125
|
]
|
|
29541
29126
|
}
|
|
29542
29127
|
},
|
|
29543
29128
|
"getters": {
|
|
29544
|
-
"
|
|
29545
|
-
"description": "The
|
|
29129
|
+
"defaultModel": {
|
|
29130
|
+
"description": "The default model used for completions, from options or 'gpt-4o'.",
|
|
29546
29131
|
"returns": "string"
|
|
29132
|
+
},
|
|
29133
|
+
"raw": {
|
|
29134
|
+
"description": "The underlying OpenAI SDK instance for advanced use cases.",
|
|
29135
|
+
"returns": "OpenAI"
|
|
29547
29136
|
}
|
|
29548
29137
|
},
|
|
29549
29138
|
"events": {
|
|
29139
|
+
"connected": {
|
|
29140
|
+
"name": "connected",
|
|
29141
|
+
"description": "Event emitted by OpenAIClient",
|
|
29142
|
+
"arguments": {}
|
|
29143
|
+
},
|
|
29550
29144
|
"failure": {
|
|
29551
29145
|
"name": "failure",
|
|
29552
|
-
"description": "Event emitted by
|
|
29146
|
+
"description": "Event emitted by OpenAIClient",
|
|
29553
29147
|
"arguments": {}
|
|
29554
29148
|
},
|
|
29555
|
-
"
|
|
29556
|
-
"name": "
|
|
29557
|
-
"description": "Event emitted by
|
|
29149
|
+
"completion": {
|
|
29150
|
+
"name": "completion",
|
|
29151
|
+
"description": "Event emitted by OpenAIClient",
|
|
29558
29152
|
"arguments": {}
|
|
29559
29153
|
},
|
|
29560
|
-
"
|
|
29561
|
-
"name": "
|
|
29562
|
-
"description": "Event emitted by
|
|
29154
|
+
"embedding": {
|
|
29155
|
+
"name": "embedding",
|
|
29156
|
+
"description": "Event emitted by OpenAIClient",
|
|
29157
|
+
"arguments": {}
|
|
29158
|
+
},
|
|
29159
|
+
"image": {
|
|
29160
|
+
"name": "image",
|
|
29161
|
+
"description": "Event emitted by OpenAIClient",
|
|
29162
|
+
"arguments": {}
|
|
29163
|
+
},
|
|
29164
|
+
"models": {
|
|
29165
|
+
"name": "models",
|
|
29166
|
+
"description": "Event emitted by OpenAIClient",
|
|
29563
29167
|
"arguments": {}
|
|
29564
29168
|
}
|
|
29565
29169
|
},
|
|
@@ -29569,71 +29173,204 @@ export const introspectionData = [
|
|
|
29569
29173
|
"examples": [
|
|
29570
29174
|
{
|
|
29571
29175
|
"language": "ts",
|
|
29572
|
-
"code": "const
|
|
29176
|
+
"code": "const openai = container.client('openai', { defaultModel: 'gpt-4o' })\nconst answer = await openai.ask('What is the meaning of life?')\nconsole.log(answer)"
|
|
29573
29177
|
}
|
|
29574
|
-
]
|
|
29575
|
-
|
|
29576
|
-
|
|
29577
|
-
|
|
29578
|
-
|
|
29579
|
-
|
|
29178
|
+
]
|
|
29179
|
+
},
|
|
29180
|
+
{
|
|
29181
|
+
"id": "clients.supabase",
|
|
29182
|
+
"description": "Supabase client for the Luca container system. Wraps the official `@supabase/supabase-js` SDK and exposes it through Luca's typed state, events, and introspection system. The SDK is isomorphic so this single implementation works in both Node and browser containers. Use `client.sdk` for full SDK access, or use the convenience wrappers for common operations (auth, database queries, storage, edge functions, realtime).",
|
|
29183
|
+
"shortcut": "clients.supabase",
|
|
29184
|
+
"className": "SupabaseClient",
|
|
29185
|
+
"methods": {
|
|
29186
|
+
"from": {
|
|
29187
|
+
"description": "Start a query on a Postgres table or view.",
|
|
29188
|
+
"parameters": {
|
|
29189
|
+
"table": {
|
|
29580
29190
|
"type": "string",
|
|
29581
|
-
"description": ""
|
|
29582
|
-
|
|
29583
|
-
|
|
29584
|
-
|
|
29191
|
+
"description": "The table or view name to query"
|
|
29192
|
+
}
|
|
29193
|
+
},
|
|
29194
|
+
"required": [
|
|
29195
|
+
"table"
|
|
29196
|
+
],
|
|
29197
|
+
"returns": "void"
|
|
29198
|
+
},
|
|
29199
|
+
"rpc": {
|
|
29200
|
+
"description": "Call a Postgres function (RPC).",
|
|
29201
|
+
"parameters": {
|
|
29202
|
+
"fn": {
|
|
29585
29203
|
"type": "string",
|
|
29586
|
-
"description": ""
|
|
29587
|
-
"optional": true
|
|
29204
|
+
"description": "The function name"
|
|
29588
29205
|
},
|
|
29589
|
-
"
|
|
29206
|
+
"params": {
|
|
29207
|
+
"type": "Record<string, unknown>",
|
|
29208
|
+
"description": "Arguments to pass to the function"
|
|
29209
|
+
},
|
|
29210
|
+
"options": {
|
|
29211
|
+
"type": "{ head?: boolean; get?: boolean; count?: \"exact\" | \"planned\" | \"estimated\" }",
|
|
29212
|
+
"description": "Optional settings (head, get, count)"
|
|
29213
|
+
}
|
|
29214
|
+
},
|
|
29215
|
+
"required": [
|
|
29216
|
+
"fn"
|
|
29217
|
+
],
|
|
29218
|
+
"returns": "void"
|
|
29219
|
+
},
|
|
29220
|
+
"signInWithPassword": {
|
|
29221
|
+
"description": "Sign in with email and password.",
|
|
29222
|
+
"parameters": {
|
|
29223
|
+
"email": {
|
|
29590
29224
|
"type": "string",
|
|
29591
|
-
"description": ""
|
|
29592
|
-
"optional": true
|
|
29225
|
+
"description": "Parameter email"
|
|
29593
29226
|
},
|
|
29594
|
-
"
|
|
29595
|
-
"type": "
|
|
29596
|
-
"description": ""
|
|
29597
|
-
|
|
29227
|
+
"password": {
|
|
29228
|
+
"type": "string",
|
|
29229
|
+
"description": "Parameter password"
|
|
29230
|
+
}
|
|
29231
|
+
},
|
|
29232
|
+
"required": [
|
|
29233
|
+
"email",
|
|
29234
|
+
"password"
|
|
29235
|
+
],
|
|
29236
|
+
"returns": "void"
|
|
29237
|
+
},
|
|
29238
|
+
"signUp": {
|
|
29239
|
+
"description": "Create a new user account with email and password.",
|
|
29240
|
+
"parameters": {
|
|
29241
|
+
"email": {
|
|
29242
|
+
"type": "string",
|
|
29243
|
+
"description": "Parameter email"
|
|
29598
29244
|
},
|
|
29599
|
-
"
|
|
29600
|
-
"type": "
|
|
29601
|
-
"description": ""
|
|
29602
|
-
"optional": true
|
|
29245
|
+
"password": {
|
|
29246
|
+
"type": "string",
|
|
29247
|
+
"description": "Parameter password"
|
|
29603
29248
|
}
|
|
29604
|
-
}
|
|
29249
|
+
},
|
|
29250
|
+
"required": [
|
|
29251
|
+
"email",
|
|
29252
|
+
"password"
|
|
29253
|
+
],
|
|
29254
|
+
"returns": "void"
|
|
29605
29255
|
},
|
|
29606
|
-
"
|
|
29607
|
-
"description": "",
|
|
29608
|
-
"
|
|
29609
|
-
|
|
29610
|
-
|
|
29611
|
-
|
|
29612
|
-
|
|
29256
|
+
"signOut": {
|
|
29257
|
+
"description": "Sign the current user out.",
|
|
29258
|
+
"parameters": {},
|
|
29259
|
+
"required": [],
|
|
29260
|
+
"returns": "void"
|
|
29261
|
+
},
|
|
29262
|
+
"getSession": {
|
|
29263
|
+
"description": "Get the current session, if any.",
|
|
29264
|
+
"parameters": {},
|
|
29265
|
+
"required": [],
|
|
29266
|
+
"returns": "void"
|
|
29267
|
+
},
|
|
29268
|
+
"getUser": {
|
|
29269
|
+
"description": "Get the current user, if any.",
|
|
29270
|
+
"parameters": {},
|
|
29271
|
+
"required": [],
|
|
29272
|
+
"returns": "void"
|
|
29273
|
+
},
|
|
29274
|
+
"invoke": {
|
|
29275
|
+
"description": "Invoke a Supabase Edge Function by name.",
|
|
29276
|
+
"parameters": {
|
|
29277
|
+
"name": {
|
|
29278
|
+
"type": "string",
|
|
29279
|
+
"description": "Parameter name"
|
|
29613
29280
|
},
|
|
29614
|
-
"
|
|
29615
|
-
"type": "
|
|
29616
|
-
"description": ""
|
|
29617
|
-
|
|
29281
|
+
"body": {
|
|
29282
|
+
"type": "any",
|
|
29283
|
+
"description": "Parameter body"
|
|
29284
|
+
}
|
|
29285
|
+
},
|
|
29286
|
+
"required": [
|
|
29287
|
+
"name"
|
|
29288
|
+
],
|
|
29289
|
+
"returns": "void"
|
|
29290
|
+
},
|
|
29291
|
+
"subscribe": {
|
|
29292
|
+
"description": "Subscribe to realtime changes on a Postgres table.",
|
|
29293
|
+
"parameters": {
|
|
29294
|
+
"channelName": {
|
|
29295
|
+
"type": "string",
|
|
29296
|
+
"description": "A name for this subscription channel"
|
|
29618
29297
|
},
|
|
29619
|
-
"
|
|
29620
|
-
"type": "
|
|
29621
|
-
"description": ""
|
|
29622
|
-
"optional": true
|
|
29298
|
+
"table": {
|
|
29299
|
+
"type": "string",
|
|
29300
|
+
"description": "The table to listen to"
|
|
29623
29301
|
},
|
|
29624
|
-
"
|
|
29625
|
-
"type": "
|
|
29626
|
-
"description": ""
|
|
29627
|
-
"optional": true
|
|
29302
|
+
"callback": {
|
|
29303
|
+
"type": "(payload: any) => void",
|
|
29304
|
+
"description": "Called with the payload on each change"
|
|
29628
29305
|
},
|
|
29629
|
-
"
|
|
29630
|
-
"type": "
|
|
29631
|
-
"description": ""
|
|
29632
|
-
"optional": true
|
|
29306
|
+
"event": {
|
|
29307
|
+
"type": "\"INSERT\" | \"UPDATE\" | \"DELETE\" | \"*\"",
|
|
29308
|
+
"description": "The event type to listen for (default: all changes)"
|
|
29633
29309
|
}
|
|
29634
|
-
}
|
|
29310
|
+
},
|
|
29311
|
+
"required": [
|
|
29312
|
+
"channelName",
|
|
29313
|
+
"table",
|
|
29314
|
+
"callback"
|
|
29315
|
+
],
|
|
29316
|
+
"returns": "RealtimeChannel"
|
|
29317
|
+
},
|
|
29318
|
+
"unsubscribe": {
|
|
29319
|
+
"description": "Unsubscribe and remove a realtime channel by name.",
|
|
29320
|
+
"parameters": {
|
|
29321
|
+
"channelName": {
|
|
29322
|
+
"type": "string",
|
|
29323
|
+
"description": "The channel name to remove"
|
|
29324
|
+
}
|
|
29325
|
+
},
|
|
29326
|
+
"required": [
|
|
29327
|
+
"channelName"
|
|
29328
|
+
],
|
|
29329
|
+
"returns": "void"
|
|
29330
|
+
},
|
|
29331
|
+
"unsubscribeAll": {
|
|
29332
|
+
"description": "Unsubscribe and remove all realtime channels.",
|
|
29333
|
+
"parameters": {},
|
|
29334
|
+
"required": [],
|
|
29335
|
+
"returns": "void"
|
|
29336
|
+
},
|
|
29337
|
+
"connect": {
|
|
29338
|
+
"description": "Connect is a no-op since the Supabase SDK initializes on construction. The client is ready to use immediately after creation.",
|
|
29339
|
+
"parameters": {},
|
|
29340
|
+
"required": [],
|
|
29341
|
+
"returns": "void"
|
|
29342
|
+
},
|
|
29343
|
+
"disconnect": {
|
|
29344
|
+
"description": "Disconnect by signing out and removing all realtime channels.",
|
|
29345
|
+
"parameters": {},
|
|
29346
|
+
"required": [],
|
|
29347
|
+
"returns": "void"
|
|
29635
29348
|
}
|
|
29636
|
-
}
|
|
29349
|
+
},
|
|
29350
|
+
"getters": {
|
|
29351
|
+
"sdk": {
|
|
29352
|
+
"description": "Returns the raw Supabase SDK client for full access to all SDK methods.",
|
|
29353
|
+
"returns": "SupabaseSDKClient<any, any>"
|
|
29354
|
+
},
|
|
29355
|
+
"storage": {
|
|
29356
|
+
"description": "Returns the Supabase Storage client for managing buckets and files.",
|
|
29357
|
+
"returns": "any"
|
|
29358
|
+
},
|
|
29359
|
+
"functions": {
|
|
29360
|
+
"description": "Returns the Supabase Functions client.",
|
|
29361
|
+
"returns": "any"
|
|
29362
|
+
}
|
|
29363
|
+
},
|
|
29364
|
+
"events": {},
|
|
29365
|
+
"state": {},
|
|
29366
|
+
"options": {},
|
|
29367
|
+
"envVars": [],
|
|
29368
|
+
"examples": [
|
|
29369
|
+
{
|
|
29370
|
+
"language": "ts",
|
|
29371
|
+
"code": "const supabase = container.client('supabase', {\n supabaseUrl: 'https://xyz.supabase.co',\n supabaseKey: 'your-anon-key',\n})\n\n// Query data\nconst { data } = await supabase.from('users').select('*')\n\n// Auth\nawait supabase.signInWithPassword('user@example.com', 'password')\n\n// Realtime\nsupabase.subscribe('changes', 'users', (payload) => {\n console.log('Change:', payload)\n})"
|
|
29372
|
+
}
|
|
29373
|
+
]
|
|
29637
29374
|
},
|
|
29638
29375
|
{
|
|
29639
29376
|
"id": "clients.comfyui",
|
|
@@ -29746,133 +29483,379 @@ export const introspectionData = [
|
|
|
29746
29483
|
"viewImage": {
|
|
29747
29484
|
"description": "Download a generated image from ComfyUI as a Buffer.",
|
|
29748
29485
|
"parameters": {
|
|
29749
|
-
"filename": {
|
|
29486
|
+
"filename": {
|
|
29487
|
+
"type": "string",
|
|
29488
|
+
"description": "The image filename"
|
|
29489
|
+
},
|
|
29490
|
+
"subfolder": {
|
|
29491
|
+
"type": "any",
|
|
29492
|
+
"description": "Subfolder within the output directory"
|
|
29493
|
+
},
|
|
29494
|
+
"type": {
|
|
29495
|
+
"type": "any",
|
|
29496
|
+
"description": "Image type ('output', 'input', 'temp')"
|
|
29497
|
+
}
|
|
29498
|
+
},
|
|
29499
|
+
"required": [
|
|
29500
|
+
"filename"
|
|
29501
|
+
],
|
|
29502
|
+
"returns": "Promise<Buffer>"
|
|
29503
|
+
},
|
|
29504
|
+
"connectWs": {
|
|
29505
|
+
"description": "Open a WebSocket connection to ComfyUI for real-time execution tracking. Events emitted: `execution_start`, `executing`, `progress`, `executed`, `execution_cached`, `execution_error`, `execution_complete`.",
|
|
29506
|
+
"parameters": {},
|
|
29507
|
+
"required": [],
|
|
29508
|
+
"returns": "Promise<void>"
|
|
29509
|
+
},
|
|
29510
|
+
"disconnectWs": {
|
|
29511
|
+
"description": "Close the WebSocket connection.",
|
|
29512
|
+
"parameters": {},
|
|
29513
|
+
"required": [],
|
|
29514
|
+
"returns": "void"
|
|
29515
|
+
},
|
|
29516
|
+
"toApiFormat": {
|
|
29517
|
+
"description": "Convert a UI-format workflow to the API format that /prompt expects. Requires a running ComfyUI instance to fetch `object_info` so we can map positional `widgets_values` to their named input fields. If the workflow is already in API format, it's returned as-is.",
|
|
29518
|
+
"parameters": {
|
|
29519
|
+
"workflow": {
|
|
29520
|
+
"type": "Record<string, any>",
|
|
29521
|
+
"description": "Parameter workflow"
|
|
29522
|
+
}
|
|
29523
|
+
},
|
|
29524
|
+
"required": [
|
|
29525
|
+
"workflow"
|
|
29526
|
+
],
|
|
29527
|
+
"returns": "Promise<Record<string, any>>"
|
|
29528
|
+
},
|
|
29529
|
+
"runWorkflow": {
|
|
29530
|
+
"description": "Run a ComfyUI workflow with optional runtime input overrides. Inputs can be provided in two forms: **Direct node mapping** (when no `inputMap` in options): ``` { '3': { seed: 42 }, '6': { text: 'a cat' } } ``` **Named inputs** (when `inputMap` is provided in options): ``` inputs: { positive_prompt: 'a cat', seed: 42 } options.inputMap: { positive_prompt: { nodeId: '6', field: 'text' }, seed: { nodeId: '3', field: 'seed' } } ```",
|
|
29531
|
+
"parameters": {
|
|
29532
|
+
"workflow": {
|
|
29533
|
+
"type": "Record<string, any>",
|
|
29534
|
+
"description": "Parameter workflow"
|
|
29535
|
+
},
|
|
29536
|
+
"inputs": {
|
|
29537
|
+
"type": "Record<string, any>",
|
|
29538
|
+
"description": "Parameter inputs"
|
|
29539
|
+
},
|
|
29540
|
+
"options": {
|
|
29541
|
+
"type": "WorkflowRunOptions",
|
|
29542
|
+
"description": "Parameter options",
|
|
29543
|
+
"properties": {
|
|
29544
|
+
"poll": {
|
|
29545
|
+
"type": "boolean",
|
|
29546
|
+
"description": "Use polling instead of WebSocket for tracking execution"
|
|
29547
|
+
},
|
|
29548
|
+
"pollInterval": {
|
|
29549
|
+
"type": "number",
|
|
29550
|
+
"description": "Polling interval in ms (default 1000)"
|
|
29551
|
+
},
|
|
29552
|
+
"inputMap": {
|
|
29553
|
+
"type": "InputMapping",
|
|
29554
|
+
"description": "Named input mapping: semantic name -> { nodeId, field }"
|
|
29555
|
+
},
|
|
29556
|
+
"outputDir": {
|
|
29557
|
+
"type": "string",
|
|
29558
|
+
"description": "If provided, output images are downloaded to this directory"
|
|
29559
|
+
}
|
|
29560
|
+
}
|
|
29561
|
+
}
|
|
29562
|
+
},
|
|
29563
|
+
"required": [
|
|
29564
|
+
"workflow"
|
|
29565
|
+
],
|
|
29566
|
+
"returns": "Promise<WorkflowResult>"
|
|
29567
|
+
}
|
|
29568
|
+
},
|
|
29569
|
+
"getters": {
|
|
29570
|
+
"clientId": {
|
|
29571
|
+
"description": "The unique client ID used for WebSocket session tracking.",
|
|
29572
|
+
"returns": "string"
|
|
29573
|
+
},
|
|
29574
|
+
"wsURL": {
|
|
29575
|
+
"description": "The WebSocket URL derived from baseURL or overridden via options.",
|
|
29576
|
+
"returns": "string"
|
|
29577
|
+
}
|
|
29578
|
+
},
|
|
29579
|
+
"events": {
|
|
29580
|
+
"execution_start": {
|
|
29581
|
+
"name": "execution_start",
|
|
29582
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29583
|
+
"arguments": {}
|
|
29584
|
+
},
|
|
29585
|
+
"execution_complete": {
|
|
29586
|
+
"name": "execution_complete",
|
|
29587
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29588
|
+
"arguments": {}
|
|
29589
|
+
},
|
|
29590
|
+
"executing": {
|
|
29591
|
+
"name": "executing",
|
|
29592
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29593
|
+
"arguments": {}
|
|
29594
|
+
},
|
|
29595
|
+
"progress": {
|
|
29596
|
+
"name": "progress",
|
|
29597
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29598
|
+
"arguments": {}
|
|
29599
|
+
},
|
|
29600
|
+
"executed": {
|
|
29601
|
+
"name": "executed",
|
|
29602
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29603
|
+
"arguments": {}
|
|
29604
|
+
},
|
|
29605
|
+
"execution_cached": {
|
|
29606
|
+
"name": "execution_cached",
|
|
29607
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29608
|
+
"arguments": {}
|
|
29609
|
+
},
|
|
29610
|
+
"execution_error": {
|
|
29611
|
+
"name": "execution_error",
|
|
29612
|
+
"description": "Event emitted by ComfyUIClient",
|
|
29613
|
+
"arguments": {}
|
|
29614
|
+
}
|
|
29615
|
+
},
|
|
29616
|
+
"state": {},
|
|
29617
|
+
"options": {},
|
|
29618
|
+
"envVars": [],
|
|
29619
|
+
"examples": [
|
|
29620
|
+
{
|
|
29621
|
+
"language": "ts",
|
|
29622
|
+
"code": "const comfy = container.client('comfyui', { baseURL: 'http://localhost:8188' })\nconst result = await comfy.runWorkflow(workflow, {\n '6': { text: 'a beautiful sunset' }\n})\nconsole.log(result.images)"
|
|
29623
|
+
}
|
|
29624
|
+
],
|
|
29625
|
+
"types": {
|
|
29626
|
+
"WorkflowRunOptions": {
|
|
29627
|
+
"description": "",
|
|
29628
|
+
"properties": {
|
|
29629
|
+
"poll": {
|
|
29630
|
+
"type": "boolean",
|
|
29631
|
+
"description": "Use polling instead of WebSocket for tracking execution",
|
|
29632
|
+
"optional": true
|
|
29633
|
+
},
|
|
29634
|
+
"pollInterval": {
|
|
29635
|
+
"type": "number",
|
|
29636
|
+
"description": "Polling interval in ms (default 1000)",
|
|
29637
|
+
"optional": true
|
|
29638
|
+
},
|
|
29639
|
+
"inputMap": {
|
|
29640
|
+
"type": "InputMapping",
|
|
29641
|
+
"description": "Named input mapping: semantic name -> { nodeId, field }",
|
|
29642
|
+
"optional": true
|
|
29643
|
+
},
|
|
29644
|
+
"outputDir": {
|
|
29645
|
+
"type": "string",
|
|
29646
|
+
"description": "If provided, output images are downloaded to this directory",
|
|
29647
|
+
"optional": true
|
|
29648
|
+
}
|
|
29649
|
+
}
|
|
29650
|
+
},
|
|
29651
|
+
"WorkflowResult": {
|
|
29652
|
+
"description": "",
|
|
29653
|
+
"properties": {
|
|
29654
|
+
"promptId": {
|
|
29655
|
+
"type": "string",
|
|
29656
|
+
"description": ""
|
|
29657
|
+
},
|
|
29658
|
+
"outputs": {
|
|
29659
|
+
"type": "Record<string, any>",
|
|
29660
|
+
"description": ""
|
|
29661
|
+
},
|
|
29662
|
+
"images": {
|
|
29663
|
+
"type": "Array<{ filename: string; subfolder: string; type: string; localPath?: string }>",
|
|
29664
|
+
"description": "",
|
|
29665
|
+
"optional": true
|
|
29666
|
+
}
|
|
29667
|
+
}
|
|
29668
|
+
}
|
|
29669
|
+
}
|
|
29670
|
+
},
|
|
29671
|
+
{
|
|
29672
|
+
"id": "clients.elevenlabs",
|
|
29673
|
+
"description": "ElevenLabs client — text-to-speech synthesis via the ElevenLabs REST API. Provides methods for listing voices, listing models, and generating speech audio. Audio is returned as a Buffer; use `say()` for a convenience method that writes to disk.",
|
|
29674
|
+
"shortcut": "clients.elevenlabs",
|
|
29675
|
+
"className": "ElevenLabsClient",
|
|
29676
|
+
"methods": {
|
|
29677
|
+
"beforeRequest": {
|
|
29678
|
+
"description": "Inject the xi-api-key header before each request.",
|
|
29679
|
+
"parameters": {},
|
|
29680
|
+
"required": [],
|
|
29681
|
+
"returns": "void"
|
|
29682
|
+
},
|
|
29683
|
+
"connect": {
|
|
29684
|
+
"description": "Validate the API key by listing available models.",
|
|
29685
|
+
"parameters": {},
|
|
29686
|
+
"required": [],
|
|
29687
|
+
"returns": "Promise<this>",
|
|
29688
|
+
"examples": [
|
|
29689
|
+
{
|
|
29690
|
+
"language": "ts",
|
|
29691
|
+
"code": "await el.connect()"
|
|
29692
|
+
}
|
|
29693
|
+
]
|
|
29694
|
+
},
|
|
29695
|
+
"listVoices": {
|
|
29696
|
+
"description": "List available voices with optional search and filtering.",
|
|
29697
|
+
"parameters": {
|
|
29698
|
+
"options": {
|
|
29699
|
+
"type": "{\n search?: string\n category?: string\n voice_type?: string\n page_size?: number\n next_page_token?: string\n }",
|
|
29700
|
+
"description": "Query parameters for filtering voices"
|
|
29701
|
+
}
|
|
29702
|
+
},
|
|
29703
|
+
"required": [],
|
|
29704
|
+
"returns": "Promise<any>",
|
|
29705
|
+
"examples": [
|
|
29706
|
+
{
|
|
29707
|
+
"language": "ts",
|
|
29708
|
+
"code": "const voices = await el.listVoices()\nconst premade = await el.listVoices({ category: 'premade' })"
|
|
29709
|
+
}
|
|
29710
|
+
]
|
|
29711
|
+
},
|
|
29712
|
+
"getVoice": {
|
|
29713
|
+
"description": "Get details for a single voice.",
|
|
29714
|
+
"parameters": {
|
|
29715
|
+
"voiceId": {
|
|
29750
29716
|
"type": "string",
|
|
29751
|
-
"description": "The
|
|
29752
|
-
},
|
|
29753
|
-
"subfolder": {
|
|
29754
|
-
"type": "any",
|
|
29755
|
-
"description": "Subfolder within the output directory"
|
|
29756
|
-
},
|
|
29757
|
-
"type": {
|
|
29758
|
-
"type": "any",
|
|
29759
|
-
"description": "Image type ('output', 'input', 'temp')"
|
|
29717
|
+
"description": "The voice ID to look up"
|
|
29760
29718
|
}
|
|
29761
29719
|
},
|
|
29762
29720
|
"required": [
|
|
29763
|
-
"
|
|
29721
|
+
"voiceId"
|
|
29764
29722
|
],
|
|
29765
|
-
"returns": "Promise<
|
|
29766
|
-
|
|
29767
|
-
|
|
29768
|
-
|
|
29769
|
-
|
|
29770
|
-
|
|
29771
|
-
|
|
29723
|
+
"returns": "Promise<any>",
|
|
29724
|
+
"examples": [
|
|
29725
|
+
{
|
|
29726
|
+
"language": "ts",
|
|
29727
|
+
"code": "const voice = await el.getVoice('21m00Tcm4TlvDq8ikWAM')\nconsole.log(voice.name, voice.settings)"
|
|
29728
|
+
}
|
|
29729
|
+
]
|
|
29772
29730
|
},
|
|
29773
|
-
"
|
|
29774
|
-
"description": "
|
|
29731
|
+
"listModels": {
|
|
29732
|
+
"description": "List available TTS models.",
|
|
29775
29733
|
"parameters": {},
|
|
29776
29734
|
"required": [],
|
|
29777
|
-
"returns": "
|
|
29735
|
+
"returns": "Promise<any[]>",
|
|
29736
|
+
"examples": [
|
|
29737
|
+
{
|
|
29738
|
+
"language": "ts",
|
|
29739
|
+
"code": "const models = await el.listModels()\nconsole.log(models.map(m => m.model_id))"
|
|
29740
|
+
}
|
|
29741
|
+
]
|
|
29778
29742
|
},
|
|
29779
|
-
"
|
|
29780
|
-
"description": "
|
|
29743
|
+
"synthesize": {
|
|
29744
|
+
"description": "Synthesize speech from text, returning audio as a Buffer.",
|
|
29781
29745
|
"parameters": {
|
|
29782
|
-
"
|
|
29783
|
-
"type": "
|
|
29784
|
-
"description": "
|
|
29746
|
+
"text": {
|
|
29747
|
+
"type": "string",
|
|
29748
|
+
"description": "The text to convert to speech"
|
|
29749
|
+
},
|
|
29750
|
+
"options": {
|
|
29751
|
+
"type": "SynthesizeOptions",
|
|
29752
|
+
"description": "Voice, model, format, and voice settings overrides",
|
|
29753
|
+
"properties": {
|
|
29754
|
+
"voiceId": {
|
|
29755
|
+
"type": "string",
|
|
29756
|
+
"description": ""
|
|
29757
|
+
},
|
|
29758
|
+
"modelId": {
|
|
29759
|
+
"type": "string",
|
|
29760
|
+
"description": ""
|
|
29761
|
+
},
|
|
29762
|
+
"outputFormat": {
|
|
29763
|
+
"type": "string",
|
|
29764
|
+
"description": ""
|
|
29765
|
+
},
|
|
29766
|
+
"voiceSettings": {
|
|
29767
|
+
"type": "ElevenLabsVoiceSettings",
|
|
29768
|
+
"description": ""
|
|
29769
|
+
},
|
|
29770
|
+
"disableCache": {
|
|
29771
|
+
"type": "boolean",
|
|
29772
|
+
"description": ""
|
|
29773
|
+
}
|
|
29774
|
+
}
|
|
29785
29775
|
}
|
|
29786
29776
|
},
|
|
29787
29777
|
"required": [
|
|
29788
|
-
"
|
|
29778
|
+
"text"
|
|
29789
29779
|
],
|
|
29790
|
-
"returns": "Promise<
|
|
29780
|
+
"returns": "Promise<Buffer>",
|
|
29781
|
+
"examples": [
|
|
29782
|
+
{
|
|
29783
|
+
"language": "ts",
|
|
29784
|
+
"code": "const audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data\n\nconst custom = await el.synthesize('Hello', {\n voiceId: '21m00Tcm4TlvDq8ikWAM',\n voiceSettings: { stability: 0.5, similarityBoost: 0.8 }\n})"
|
|
29785
|
+
}
|
|
29786
|
+
]
|
|
29791
29787
|
},
|
|
29792
|
-
"
|
|
29793
|
-
"description": "
|
|
29788
|
+
"say": {
|
|
29789
|
+
"description": "Synthesize speech and write the audio to a file.",
|
|
29794
29790
|
"parameters": {
|
|
29795
|
-
"
|
|
29796
|
-
"type": "
|
|
29797
|
-
"description": "
|
|
29791
|
+
"text": {
|
|
29792
|
+
"type": "string",
|
|
29793
|
+
"description": "The text to convert to speech"
|
|
29798
29794
|
},
|
|
29799
|
-
"
|
|
29800
|
-
"type": "
|
|
29801
|
-
"description": "
|
|
29795
|
+
"outputPath": {
|
|
29796
|
+
"type": "string",
|
|
29797
|
+
"description": "File path to write the audio to"
|
|
29802
29798
|
},
|
|
29803
29799
|
"options": {
|
|
29804
|
-
"type": "
|
|
29805
|
-
"description": "
|
|
29800
|
+
"type": "SynthesizeOptions",
|
|
29801
|
+
"description": "Voice, model, format, and voice settings overrides",
|
|
29806
29802
|
"properties": {
|
|
29807
|
-
"
|
|
29808
|
-
"type": "
|
|
29809
|
-
"description": "
|
|
29810
|
-
},
|
|
29811
|
-
"pollInterval": {
|
|
29812
|
-
"type": "number",
|
|
29813
|
-
"description": "Polling interval in ms (default 1000)"
|
|
29803
|
+
"voiceId": {
|
|
29804
|
+
"type": "string",
|
|
29805
|
+
"description": ""
|
|
29814
29806
|
},
|
|
29815
|
-
"
|
|
29816
|
-
"type": "
|
|
29817
|
-
"description": "
|
|
29807
|
+
"modelId": {
|
|
29808
|
+
"type": "string",
|
|
29809
|
+
"description": ""
|
|
29818
29810
|
},
|
|
29819
|
-
"
|
|
29811
|
+
"outputFormat": {
|
|
29820
29812
|
"type": "string",
|
|
29821
|
-
"description": "
|
|
29813
|
+
"description": ""
|
|
29814
|
+
},
|
|
29815
|
+
"voiceSettings": {
|
|
29816
|
+
"type": "ElevenLabsVoiceSettings",
|
|
29817
|
+
"description": ""
|
|
29818
|
+
},
|
|
29819
|
+
"disableCache": {
|
|
29820
|
+
"type": "boolean",
|
|
29821
|
+
"description": ""
|
|
29822
29822
|
}
|
|
29823
29823
|
}
|
|
29824
29824
|
}
|
|
29825
29825
|
},
|
|
29826
29826
|
"required": [
|
|
29827
|
-
"
|
|
29827
|
+
"text",
|
|
29828
|
+
"outputPath"
|
|
29828
29829
|
],
|
|
29829
|
-
"returns": "Promise<
|
|
29830
|
+
"returns": "Promise<string>",
|
|
29831
|
+
"examples": [
|
|
29832
|
+
{
|
|
29833
|
+
"language": "ts",
|
|
29834
|
+
"code": "const path = await el.say('Hello world', './hello.mp3')\nconsole.log(`Audio saved to ${path}`)"
|
|
29835
|
+
}
|
|
29836
|
+
]
|
|
29830
29837
|
}
|
|
29831
29838
|
},
|
|
29832
29839
|
"getters": {
|
|
29833
|
-
"
|
|
29834
|
-
"description": "The
|
|
29835
|
-
"returns": "string"
|
|
29836
|
-
},
|
|
29837
|
-
"wsURL": {
|
|
29838
|
-
"description": "The WebSocket URL derived from baseURL or overridden via options.",
|
|
29840
|
+
"apiKey": {
|
|
29841
|
+
"description": "The resolved API key from options or environment.",
|
|
29839
29842
|
"returns": "string"
|
|
29840
29843
|
}
|
|
29841
29844
|
},
|
|
29842
29845
|
"events": {
|
|
29843
|
-
"
|
|
29844
|
-
"name": "
|
|
29845
|
-
"description": "Event emitted by
|
|
29846
|
-
"arguments": {}
|
|
29847
|
-
},
|
|
29848
|
-
"execution_complete": {
|
|
29849
|
-
"name": "execution_complete",
|
|
29850
|
-
"description": "Event emitted by ComfyUIClient",
|
|
29851
|
-
"arguments": {}
|
|
29852
|
-
},
|
|
29853
|
-
"executing": {
|
|
29854
|
-
"name": "executing",
|
|
29855
|
-
"description": "Event emitted by ComfyUIClient",
|
|
29856
|
-
"arguments": {}
|
|
29857
|
-
},
|
|
29858
|
-
"progress": {
|
|
29859
|
-
"name": "progress",
|
|
29860
|
-
"description": "Event emitted by ComfyUIClient",
|
|
29861
|
-
"arguments": {}
|
|
29862
|
-
},
|
|
29863
|
-
"executed": {
|
|
29864
|
-
"name": "executed",
|
|
29865
|
-
"description": "Event emitted by ComfyUIClient",
|
|
29846
|
+
"failure": {
|
|
29847
|
+
"name": "failure",
|
|
29848
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
29866
29849
|
"arguments": {}
|
|
29867
29850
|
},
|
|
29868
|
-
"
|
|
29869
|
-
"name": "
|
|
29870
|
-
"description": "Event emitted by
|
|
29851
|
+
"voices": {
|
|
29852
|
+
"name": "voices",
|
|
29853
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
29871
29854
|
"arguments": {}
|
|
29872
29855
|
},
|
|
29873
|
-
"
|
|
29874
|
-
"name": "
|
|
29875
|
-
"description": "Event emitted by
|
|
29856
|
+
"speech": {
|
|
29857
|
+
"name": "speech",
|
|
29858
|
+
"description": "Event emitted by ElevenLabsClient",
|
|
29876
29859
|
"arguments": {}
|
|
29877
29860
|
}
|
|
29878
29861
|
},
|
|
@@ -29882,48 +29865,65 @@ export const introspectionData = [
|
|
|
29882
29865
|
"examples": [
|
|
29883
29866
|
{
|
|
29884
29867
|
"language": "ts",
|
|
29885
|
-
"code": "const
|
|
29868
|
+
"code": "const el = container.client('elevenlabs')\nawait el.connect()\nconst voices = await el.listVoices()\nconst audio = await el.synthesize('Hello world')\n// audio is a Buffer of mp3 data"
|
|
29886
29869
|
}
|
|
29887
29870
|
],
|
|
29888
29871
|
"types": {
|
|
29889
|
-
"
|
|
29872
|
+
"SynthesizeOptions": {
|
|
29890
29873
|
"description": "",
|
|
29891
29874
|
"properties": {
|
|
29892
|
-
"
|
|
29893
|
-
"type": "
|
|
29894
|
-
"description": "
|
|
29875
|
+
"voiceId": {
|
|
29876
|
+
"type": "string",
|
|
29877
|
+
"description": "",
|
|
29895
29878
|
"optional": true
|
|
29896
29879
|
},
|
|
29897
|
-
"
|
|
29898
|
-
"type": "
|
|
29899
|
-
"description": "
|
|
29880
|
+
"modelId": {
|
|
29881
|
+
"type": "string",
|
|
29882
|
+
"description": "",
|
|
29900
29883
|
"optional": true
|
|
29901
29884
|
},
|
|
29902
|
-
"
|
|
29903
|
-
"type": "
|
|
29904
|
-
"description": "
|
|
29885
|
+
"outputFormat": {
|
|
29886
|
+
"type": "string",
|
|
29887
|
+
"description": "",
|
|
29905
29888
|
"optional": true
|
|
29906
29889
|
},
|
|
29907
|
-
"
|
|
29908
|
-
"type": "
|
|
29909
|
-
"description": "
|
|
29890
|
+
"voiceSettings": {
|
|
29891
|
+
"type": "ElevenLabsVoiceSettings",
|
|
29892
|
+
"description": "",
|
|
29893
|
+
"optional": true
|
|
29894
|
+
},
|
|
29895
|
+
"disableCache": {
|
|
29896
|
+
"type": "boolean",
|
|
29897
|
+
"description": "",
|
|
29910
29898
|
"optional": true
|
|
29911
29899
|
}
|
|
29912
29900
|
}
|
|
29913
29901
|
},
|
|
29914
|
-
"
|
|
29902
|
+
"ElevenLabsVoiceSettings": {
|
|
29915
29903
|
"description": "",
|
|
29916
29904
|
"properties": {
|
|
29917
|
-
"
|
|
29918
|
-
"type": "
|
|
29919
|
-
"description": ""
|
|
29905
|
+
"stability": {
|
|
29906
|
+
"type": "number",
|
|
29907
|
+
"description": "",
|
|
29908
|
+
"optional": true
|
|
29920
29909
|
},
|
|
29921
|
-
"
|
|
29922
|
-
"type": "
|
|
29923
|
-
"description": ""
|
|
29910
|
+
"similarityBoost": {
|
|
29911
|
+
"type": "number",
|
|
29912
|
+
"description": "",
|
|
29913
|
+
"optional": true
|
|
29924
29914
|
},
|
|
29925
|
-
"
|
|
29926
|
-
"type": "
|
|
29915
|
+
"style": {
|
|
29916
|
+
"type": "number",
|
|
29917
|
+
"description": "",
|
|
29918
|
+
"optional": true
|
|
29919
|
+
},
|
|
29920
|
+
"speed": {
|
|
29921
|
+
"type": "number",
|
|
29922
|
+
"description": "",
|
|
29923
|
+
"optional": true
|
|
29924
|
+
},
|
|
29925
|
+
"useSpeakerBoost": {
|
|
29926
|
+
"type": "boolean",
|
|
29927
29927
|
"description": "",
|
|
29928
29928
|
"optional": true
|
|
29929
29929
|
}
|