@agents24/node 0.1.0
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/LICENSE +21 -0
- package/README.md +42 -0
- package/compatibility.json +54 -0
- package/dist/artifacts.cjs +138 -0
- package/dist/artifacts.cjs.map +1 -0
- package/dist/artifacts.d.cts +76 -0
- package/dist/artifacts.d.ts +76 -0
- package/dist/artifacts.js +130 -0
- package/dist/artifacts.js.map +1 -0
- package/dist/index.cjs +733 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +564 -0
- package/dist/index.d.ts +564 -0
- package/dist/index.js +667 -0
- package/dist/index.js.map +1 -0
- package/dist/server.cjs +275 -0
- package/dist/server.cjs.map +1 -0
- package/dist/server.d.cts +47 -0
- package/dist/server.d.ts +47 -0
- package/dist/server.js +271 -0
- package/dist/server.js.map +1 -0
- package/dist/types/agents.d.ts +28 -0
- package/dist/types/agents.d.ts.map +1 -0
- package/dist/types/artifacts.d.ts +75 -0
- package/dist/types/artifacts.d.ts.map +1 -0
- package/dist/types/builders.d.ts +27 -0
- package/dist/types/builders.d.ts.map +1 -0
- package/dist/types/client-runtime-admin.d.ts +17 -0
- package/dist/types/client-runtime-admin.d.ts.map +1 -0
- package/dist/types/client.d.ts +17 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/embed.d.ts +22 -0
- package/dist/types/embed.d.ts.map +1 -0
- package/dist/types/errors.d.ts +17 -0
- package/dist/types/errors.d.ts.map +1 -0
- package/dist/types/generated/manifest.d.ts +3 -0
- package/dist/types/generated/manifest.d.ts.map +1 -0
- package/dist/types/http.d.ts +25 -0
- package/dist/types/http.d.ts.map +1 -0
- package/dist/types/index.d.ts +10 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/runs.d.ts +17 -0
- package/dist/types/runs.d.ts.map +1 -0
- package/dist/types/server.d.ts +45 -0
- package/dist/types/server.d.ts.map +1 -0
- package/dist/types/streams.d.ts +4 -0
- package/dist/types/streams.d.ts.map +1 -0
- package/dist/types/types.d.ts +409 -0
- package/dist/types/types.d.ts.map +1 -0
- package/package.json +85 -0
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,564 @@
|
|
|
1
|
+
import { ToolInputOverrides, ContextWindow, RuntimeEvent, RunContext, RunCancelResult, AttachmentUploadResult, RunResumeResult, ThreadsResponse, ThreadSummaryEvent, ThreadDetail, ThreadDeleteResult } from '@agents24/client/protocol';
|
|
2
|
+
export { ActiveThreadRun, Attachment, AttachmentUploadResult, CONTRACT_HASH, ContextCompression, ContextWindow, ContextWindowConfidence, ContextWindowSource, ContextWindowStage, ContextWindowTracker, JsonScalar, JsonValue, ProtocolErrorCategory, PublicResponseBlock, RUNTIME_PROTOCOL_VERSION, PublicResponseBlock as ResponseBlock, RunCancelResult, RunContext, RunResumeResult, RuntimeEvent, THREAD_SUMMARY_PROTOCOL_VERSION, ThreadDeleteResult, ThreadDetail, ThreadSummary, ThreadSummaryEvent, ThreadTurn, ThreadsResponse, ToolInputOverrides, compressionFromContextWindow, createContextWindowTracker, mergeContextWindow, mergeContextWindowUpdate, normalizeContextCompression, normalizeContextWindow, parseRuntimeEvent, parseRuntimeSsePayload, parseThreadSummarySsePayload, validateResponseBlock, validateRuntimeEvent, validateThreadSummaryEvent } from '@agents24/client/protocol';
|
|
3
|
+
|
|
4
|
+
type Agents24SDKErrorKind = "protocol" | "network" | "http";
|
|
5
|
+
type Agents24NodeErrorKind = Agents24SDKErrorKind;
|
|
6
|
+
declare class Agents24SDKError extends Error {
|
|
7
|
+
readonly kind: Agents24SDKErrorKind;
|
|
8
|
+
readonly status?: number;
|
|
9
|
+
readonly details?: unknown;
|
|
10
|
+
readonly responseHeaders?: Readonly<Record<string, string>>;
|
|
11
|
+
constructor(message: string, options: {
|
|
12
|
+
kind: Agents24SDKErrorKind;
|
|
13
|
+
status?: number;
|
|
14
|
+
details?: unknown;
|
|
15
|
+
responseHeaders?: Readonly<Record<string, string>>;
|
|
16
|
+
cause?: unknown;
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
type Agents24NodeOptions = {
|
|
21
|
+
baseUrl: string;
|
|
22
|
+
apiKey: string;
|
|
23
|
+
organizationId: string;
|
|
24
|
+
projectId: string;
|
|
25
|
+
fetchImpl?: typeof fetch;
|
|
26
|
+
};
|
|
27
|
+
/** @deprecated Use Agents24NodeOptions. */
|
|
28
|
+
type Agents24Options = Agents24NodeOptions;
|
|
29
|
+
type RequestOptions = {
|
|
30
|
+
idempotencyKey?: string;
|
|
31
|
+
dryRun?: boolean;
|
|
32
|
+
validateOnly?: boolean;
|
|
33
|
+
requestMetadata?: Record<string, unknown>;
|
|
34
|
+
};
|
|
35
|
+
type BackendSessionRequestOptions = RequestOptions & {
|
|
36
|
+
dpopProof?: string;
|
|
37
|
+
};
|
|
38
|
+
type StreamRequestOptions = RequestOptions & {
|
|
39
|
+
signal?: AbortSignal;
|
|
40
|
+
};
|
|
41
|
+
type AgentStreamRequest = {
|
|
42
|
+
input?: string;
|
|
43
|
+
messages?: Array<Record<string, unknown>>;
|
|
44
|
+
attachment_ids?: string[];
|
|
45
|
+
thread_id?: string;
|
|
46
|
+
runtime_context?: Record<string, unknown>;
|
|
47
|
+
tool_inputs?: ToolInputOverrides;
|
|
48
|
+
requested_model_id?: string;
|
|
49
|
+
requested_model_node_id?: string;
|
|
50
|
+
external_user_id?: string;
|
|
51
|
+
external_session_id?: string;
|
|
52
|
+
metadata?: Record<string, unknown>;
|
|
53
|
+
client?: Record<string, unknown>;
|
|
54
|
+
node_state?: Record<string, unknown>;
|
|
55
|
+
runtime_target?: "draft" | "published";
|
|
56
|
+
agent_version_id?: string;
|
|
57
|
+
};
|
|
58
|
+
type StreamResult = {
|
|
59
|
+
threadId: string | null;
|
|
60
|
+
runId: string | null;
|
|
61
|
+
};
|
|
62
|
+
type EmbedStreamRequest = {
|
|
63
|
+
input?: string;
|
|
64
|
+
messages?: Array<Record<string, unknown>>;
|
|
65
|
+
attachment_ids?: string[];
|
|
66
|
+
thread_id?: string;
|
|
67
|
+
runtime_context?: Record<string, unknown>;
|
|
68
|
+
tool_inputs?: ToolInputOverrides;
|
|
69
|
+
requested_model_id?: string;
|
|
70
|
+
requested_model_node_id?: string;
|
|
71
|
+
external_user_id: string;
|
|
72
|
+
external_session_id?: string;
|
|
73
|
+
metadata?: Record<string, unknown>;
|
|
74
|
+
client?: Record<string, unknown>;
|
|
75
|
+
};
|
|
76
|
+
type AttachRunRequest = {
|
|
77
|
+
external_user_id: string;
|
|
78
|
+
external_session_id?: string;
|
|
79
|
+
metadata?: Record<string, unknown>;
|
|
80
|
+
client?: Record<string, unknown>;
|
|
81
|
+
};
|
|
82
|
+
type HitlAction = "approve" | "reject" | "connect" | "skip";
|
|
83
|
+
type ResumeRunRequest = AttachRunRequest & {
|
|
84
|
+
schema_version: "agents24.hitl.resume.v2";
|
|
85
|
+
interrupt_id: string;
|
|
86
|
+
action: HitlAction;
|
|
87
|
+
comment?: string;
|
|
88
|
+
};
|
|
89
|
+
type McpAuthStartRequest = AttachRunRequest & {
|
|
90
|
+
interrupt_id: string;
|
|
91
|
+
callback_origin: string;
|
|
92
|
+
popup_nonce: string;
|
|
93
|
+
};
|
|
94
|
+
type McpAuthStartResult = {
|
|
95
|
+
authorization_url: string;
|
|
96
|
+
callback_origin: string;
|
|
97
|
+
};
|
|
98
|
+
type EmbedRuntimeBootstrap = {
|
|
99
|
+
version: string;
|
|
100
|
+
model_selector?: Record<string, unknown> | null;
|
|
101
|
+
thread_events_path?: string | null;
|
|
102
|
+
thread_events_url?: string | null;
|
|
103
|
+
};
|
|
104
|
+
type MultiAgentThreadListRequest = {
|
|
105
|
+
agent_ids: string[];
|
|
106
|
+
external_user_id: string;
|
|
107
|
+
external_session_id?: string | null;
|
|
108
|
+
skip?: number;
|
|
109
|
+
limit?: number;
|
|
110
|
+
};
|
|
111
|
+
type ThreadListOptions = {
|
|
112
|
+
externalUserId: string;
|
|
113
|
+
externalSessionId?: string;
|
|
114
|
+
skip?: number;
|
|
115
|
+
limit?: number;
|
|
116
|
+
};
|
|
117
|
+
type ThreadDetailOptions = {
|
|
118
|
+
externalUserId: string;
|
|
119
|
+
externalSessionId?: string;
|
|
120
|
+
beforeTurnIndex?: number;
|
|
121
|
+
limit?: number;
|
|
122
|
+
includeRunEvents?: boolean;
|
|
123
|
+
includeSubthreads?: boolean;
|
|
124
|
+
subthreadDepth?: number;
|
|
125
|
+
subthreadTurnLimit?: number;
|
|
126
|
+
subthreadChildLimit?: number;
|
|
127
|
+
};
|
|
128
|
+
type RunContextOptions = {
|
|
129
|
+
externalUserId: string;
|
|
130
|
+
externalSessionId?: string;
|
|
131
|
+
};
|
|
132
|
+
type RunCancelOptions = {
|
|
133
|
+
externalUserId?: string;
|
|
134
|
+
externalSessionId?: string;
|
|
135
|
+
assistantOutputText?: string;
|
|
136
|
+
};
|
|
137
|
+
type EmbedRunCancelOptions = {
|
|
138
|
+
externalUserId?: string;
|
|
139
|
+
externalSessionId?: string;
|
|
140
|
+
};
|
|
141
|
+
type ThreadDeleteOptions = {
|
|
142
|
+
externalUserId: string;
|
|
143
|
+
externalSessionId?: string;
|
|
144
|
+
};
|
|
145
|
+
type ThreadSummaryEventOptions = {
|
|
146
|
+
externalUserId: string;
|
|
147
|
+
externalSessionId?: string | null;
|
|
148
|
+
cursor?: number | null;
|
|
149
|
+
signal?: AbortSignal;
|
|
150
|
+
};
|
|
151
|
+
type MultiAgentThreadSummaryEventOptions = ThreadSummaryEventOptions & {
|
|
152
|
+
agentIds: string[];
|
|
153
|
+
};
|
|
154
|
+
type ServerAttachmentUploadOptions = {
|
|
155
|
+
threadId?: string;
|
|
156
|
+
files: File[];
|
|
157
|
+
idempotencyKey?: string;
|
|
158
|
+
};
|
|
159
|
+
type ServerEmbedAttachmentUploadOptions = ServerAttachmentUploadOptions & {
|
|
160
|
+
externalUserId: string;
|
|
161
|
+
externalSessionId?: string;
|
|
162
|
+
};
|
|
163
|
+
type GraphNode = {
|
|
164
|
+
id: string;
|
|
165
|
+
type: string;
|
|
166
|
+
position: {
|
|
167
|
+
x: number;
|
|
168
|
+
y: number;
|
|
169
|
+
};
|
|
170
|
+
config: Record<string, unknown>;
|
|
171
|
+
label?: string;
|
|
172
|
+
data?: Record<string, unknown>;
|
|
173
|
+
input_mappings?: Record<string, unknown>;
|
|
174
|
+
};
|
|
175
|
+
type GraphEdge = {
|
|
176
|
+
id: string;
|
|
177
|
+
source: string;
|
|
178
|
+
target: string;
|
|
179
|
+
type?: string;
|
|
180
|
+
source_handle?: string;
|
|
181
|
+
target_handle?: string;
|
|
182
|
+
label?: string;
|
|
183
|
+
condition?: Record<string, unknown>;
|
|
184
|
+
};
|
|
185
|
+
type GraphDefinition = {
|
|
186
|
+
spec_version?: string;
|
|
187
|
+
graph_type?: "agent";
|
|
188
|
+
workflow_contract?: Record<string, unknown>;
|
|
189
|
+
state_contract?: Record<string, unknown>;
|
|
190
|
+
nodes: GraphNode[];
|
|
191
|
+
edges: GraphEdge[];
|
|
192
|
+
};
|
|
193
|
+
type AgentCreateRequest = {
|
|
194
|
+
name: string;
|
|
195
|
+
description?: string | null;
|
|
196
|
+
graph_definition: GraphDefinition;
|
|
197
|
+
memory_config?: Record<string, unknown>;
|
|
198
|
+
execution_constraints?: Record<string, unknown>;
|
|
199
|
+
};
|
|
200
|
+
type AgentUpdateRequest = Partial<AgentCreateRequest> & {
|
|
201
|
+
status?: string;
|
|
202
|
+
is_active?: boolean;
|
|
203
|
+
};
|
|
204
|
+
type AgentResponse = {
|
|
205
|
+
id: string;
|
|
206
|
+
organization_id: string;
|
|
207
|
+
project_id?: string | null;
|
|
208
|
+
name: string;
|
|
209
|
+
description?: string | null;
|
|
210
|
+
graph_definition: GraphDefinition;
|
|
211
|
+
memory_config: Record<string, unknown>;
|
|
212
|
+
execution_constraints: Record<string, unknown>;
|
|
213
|
+
status: string;
|
|
214
|
+
version: number;
|
|
215
|
+
is_active: boolean;
|
|
216
|
+
is_public: boolean;
|
|
217
|
+
show_in_playground: boolean;
|
|
218
|
+
default_embed_policy_set_id?: string | null;
|
|
219
|
+
created_at: string;
|
|
220
|
+
updated_at: string;
|
|
221
|
+
published_at?: string | null;
|
|
222
|
+
active_published_version_id?: string | null;
|
|
223
|
+
has_unpublished_changes: boolean;
|
|
224
|
+
};
|
|
225
|
+
type AgentListResponse = {
|
|
226
|
+
items: AgentResponse[];
|
|
227
|
+
total: number;
|
|
228
|
+
};
|
|
229
|
+
type StartRunResult = {
|
|
230
|
+
run_id: string;
|
|
231
|
+
thread_id?: string | null;
|
|
232
|
+
};
|
|
233
|
+
type RunStatus = {
|
|
234
|
+
id: string;
|
|
235
|
+
status: string;
|
|
236
|
+
result?: unknown;
|
|
237
|
+
error?: string | null;
|
|
238
|
+
checkpoint?: Record<string, unknown> | null;
|
|
239
|
+
run_usage?: Record<string, unknown>;
|
|
240
|
+
context_window?: ContextWindow | null;
|
|
241
|
+
lineage?: Record<string, unknown>;
|
|
242
|
+
pending_interrupts?: Array<Record<string, unknown>>;
|
|
243
|
+
run_tree?: Record<string, unknown>;
|
|
244
|
+
};
|
|
245
|
+
type ControlPlaneRunEventsResponse = {
|
|
246
|
+
events: RuntimeEvent[];
|
|
247
|
+
[key: string]: unknown;
|
|
248
|
+
};
|
|
249
|
+
type RunTrace = {
|
|
250
|
+
run: RunStatus;
|
|
251
|
+
tree: Record<string, unknown>;
|
|
252
|
+
events: ControlPlaneRunEventsResponse;
|
|
253
|
+
context: RunContext;
|
|
254
|
+
};
|
|
255
|
+
type AgentRef = string | {
|
|
256
|
+
id: string;
|
|
257
|
+
};
|
|
258
|
+
type LatestOrPinnedPolicy = {
|
|
259
|
+
mode: "latest";
|
|
260
|
+
} | {
|
|
261
|
+
mode: "pinned";
|
|
262
|
+
versionId: string;
|
|
263
|
+
};
|
|
264
|
+
type AgentToolsetAttachment = {
|
|
265
|
+
toolset: AgentRef;
|
|
266
|
+
loadingMode?: "static" | "dynamic";
|
|
267
|
+
versionPolicy?: LatestOrPinnedPolicy;
|
|
268
|
+
};
|
|
269
|
+
type AgentDefinitionOptions = {
|
|
270
|
+
name: string;
|
|
271
|
+
description?: string;
|
|
272
|
+
instructions?: string;
|
|
273
|
+
model?: AgentRef;
|
|
274
|
+
tools?: AgentRef[];
|
|
275
|
+
toolsetAttachments?: AgentToolsetAttachment[];
|
|
276
|
+
knowledge?: AgentRef[];
|
|
277
|
+
memory?: Record<string, unknown>;
|
|
278
|
+
execution?: Record<string, unknown>;
|
|
279
|
+
};
|
|
280
|
+
type Agents24SDKSerializedError = {
|
|
281
|
+
message: string;
|
|
282
|
+
kind: Agents24SDKErrorKind;
|
|
283
|
+
status?: number;
|
|
284
|
+
details?: unknown;
|
|
285
|
+
};
|
|
286
|
+
type ClientAuthMode = "anonymous" | "backend_exchange" | "external_oidc";
|
|
287
|
+
type NativePlatform = "react_native" | "electron" | "tauri";
|
|
288
|
+
type ClientRuntimeNativeProfileInput = {
|
|
289
|
+
name: string;
|
|
290
|
+
platform: NativePlatform;
|
|
291
|
+
application_id: string;
|
|
292
|
+
redirect_uris: string[];
|
|
293
|
+
attestation_required?: boolean;
|
|
294
|
+
};
|
|
295
|
+
type ClientRuntimeOidcConfig = {
|
|
296
|
+
issuer: string;
|
|
297
|
+
client_id: string;
|
|
298
|
+
audience: string;
|
|
299
|
+
authorization_endpoint?: string | null;
|
|
300
|
+
token_endpoint?: string | null;
|
|
301
|
+
jwks_uri?: string | null;
|
|
302
|
+
redirect_uris?: string[];
|
|
303
|
+
algorithms?: ["RS256"];
|
|
304
|
+
max_authentication_age_seconds?: number;
|
|
305
|
+
};
|
|
306
|
+
type ClientRuntimePolicyInput = {
|
|
307
|
+
capabilities?: string[];
|
|
308
|
+
model?: {
|
|
309
|
+
allow_selection?: boolean;
|
|
310
|
+
allowed_model_ids?: string[];
|
|
311
|
+
default_model_id?: string | null;
|
|
312
|
+
};
|
|
313
|
+
tools?: {
|
|
314
|
+
allowed_tool_ids?: string[];
|
|
315
|
+
allow_input_overrides?: boolean;
|
|
316
|
+
allow_side_effecting_anonymous?: boolean;
|
|
317
|
+
};
|
|
318
|
+
attachments?: {
|
|
319
|
+
enabled?: boolean;
|
|
320
|
+
max_files_per_request?: number;
|
|
321
|
+
max_file_bytes?: number;
|
|
322
|
+
max_total_bytes?: number;
|
|
323
|
+
allowed_mime_types?: string[];
|
|
324
|
+
max_image_pixels?: number;
|
|
325
|
+
max_pdf_pages?: number;
|
|
326
|
+
max_extracted_characters?: number;
|
|
327
|
+
retention_seconds?: number;
|
|
328
|
+
malware_scan_required?: boolean;
|
|
329
|
+
};
|
|
330
|
+
hitl?: {
|
|
331
|
+
enabled?: boolean;
|
|
332
|
+
allowed_actions?: HitlAction[];
|
|
333
|
+
};
|
|
334
|
+
mcp?: {
|
|
335
|
+
enabled?: boolean;
|
|
336
|
+
allowed_server_ids?: string[];
|
|
337
|
+
};
|
|
338
|
+
quotas?: {
|
|
339
|
+
session_mints_per_minute?: number;
|
|
340
|
+
refreshes_per_minute?: number;
|
|
341
|
+
chat_starts_per_minute?: number;
|
|
342
|
+
active_runs?: number;
|
|
343
|
+
concurrent_streams?: number;
|
|
344
|
+
upload_count_per_hour?: number;
|
|
345
|
+
upload_bytes_per_hour?: number;
|
|
346
|
+
hitl_resumes_per_minute?: number;
|
|
347
|
+
mcp_starts_per_minute?: number;
|
|
348
|
+
token_reservation_per_run?: number;
|
|
349
|
+
};
|
|
350
|
+
};
|
|
351
|
+
type CreateClientDeploymentRequest = {
|
|
352
|
+
agent_id: string;
|
|
353
|
+
agent_version_id: string;
|
|
354
|
+
name: string;
|
|
355
|
+
description?: string | null;
|
|
356
|
+
auth_modes: ClientAuthMode[];
|
|
357
|
+
allowed_origins?: string[];
|
|
358
|
+
native_profiles?: ClientRuntimeNativeProfileInput[];
|
|
359
|
+
oidc?: ClientRuntimeOidcConfig | null;
|
|
360
|
+
policy?: ClientRuntimePolicyInput;
|
|
361
|
+
};
|
|
362
|
+
type UpdateClientDeploymentRequest = Partial<Omit<CreateClientDeploymentRequest, "agent_id" | "agent_version_id">> & {
|
|
363
|
+
enabled?: boolean;
|
|
364
|
+
};
|
|
365
|
+
type PromoteClientDeploymentRequest = {
|
|
366
|
+
agent_version_id: string;
|
|
367
|
+
};
|
|
368
|
+
type ClientNativeProfile = {
|
|
369
|
+
id: string;
|
|
370
|
+
profile_id: string;
|
|
371
|
+
name: string;
|
|
372
|
+
platform: NativePlatform;
|
|
373
|
+
application_id: string;
|
|
374
|
+
redirect_uris: string[];
|
|
375
|
+
dpop_required: boolean;
|
|
376
|
+
attestation_policy: Record<string, unknown>;
|
|
377
|
+
status: string;
|
|
378
|
+
created_at: string;
|
|
379
|
+
updated_at: string;
|
|
380
|
+
revoked_at: string | null;
|
|
381
|
+
};
|
|
382
|
+
type ClientDeployment = {
|
|
383
|
+
id: string;
|
|
384
|
+
client_id: string;
|
|
385
|
+
organization_id: string;
|
|
386
|
+
project_id: string;
|
|
387
|
+
agent_id: string;
|
|
388
|
+
agent_version_id: string;
|
|
389
|
+
name: string;
|
|
390
|
+
description: string | null;
|
|
391
|
+
enabled: boolean;
|
|
392
|
+
status: "active" | "revoked";
|
|
393
|
+
policy_epoch: number;
|
|
394
|
+
revocation_epoch: number;
|
|
395
|
+
auth_modes: ClientAuthMode[];
|
|
396
|
+
allowed_origins: string[];
|
|
397
|
+
scopes: string[];
|
|
398
|
+
capabilities: string[];
|
|
399
|
+
policy: Record<string, Record<string, unknown>>;
|
|
400
|
+
oidc: ClientRuntimeOidcConfig | null;
|
|
401
|
+
native_profiles: ClientNativeProfile[];
|
|
402
|
+
created_at: string;
|
|
403
|
+
updated_at: string;
|
|
404
|
+
promoted_at: string | null;
|
|
405
|
+
revoked_at: string | null;
|
|
406
|
+
};
|
|
407
|
+
type CreateBackendClientSessionRequest = {
|
|
408
|
+
subject: string;
|
|
409
|
+
subject_issuer?: string;
|
|
410
|
+
browser_origin?: string;
|
|
411
|
+
native_profile_id?: string;
|
|
412
|
+
requested_capabilities?: string[];
|
|
413
|
+
persistent?: boolean;
|
|
414
|
+
dpop_public_jwk?: Record<string, unknown>;
|
|
415
|
+
};
|
|
416
|
+
type ClientSessionCredentials = {
|
|
417
|
+
session_id: string;
|
|
418
|
+
access_token: string;
|
|
419
|
+
token_type: "Bearer" | "DPoP";
|
|
420
|
+
expires_at: string;
|
|
421
|
+
refresh_grant: string | null;
|
|
422
|
+
refresh_expires_at: string | null;
|
|
423
|
+
dpop_nonce: string | null;
|
|
424
|
+
};
|
|
425
|
+
|
|
426
|
+
type RequestConfig = {
|
|
427
|
+
method?: string;
|
|
428
|
+
query?: Record<string, unknown>;
|
|
429
|
+
body?: unknown;
|
|
430
|
+
headers?: HeadersInit;
|
|
431
|
+
options?: RequestOptions;
|
|
432
|
+
mutation?: boolean;
|
|
433
|
+
};
|
|
434
|
+
declare class Agents24HttpClient {
|
|
435
|
+
private readonly base;
|
|
436
|
+
private readonly apiKey;
|
|
437
|
+
private readonly organizationId;
|
|
438
|
+
private readonly projectId;
|
|
439
|
+
private readonly fetchImpl;
|
|
440
|
+
constructor(options: Agents24NodeOptions);
|
|
441
|
+
url(requestPath: string, query?: Record<string, unknown>): string;
|
|
442
|
+
jsonHeaders(extra?: HeadersInit, options?: RequestOptions, mutation?: boolean): HeadersInit;
|
|
443
|
+
streamHeaders(extra?: HeadersInit, options?: RequestOptions, mutation?: boolean): HeadersInit;
|
|
444
|
+
multipartHeaders(extra?: HeadersInit, options?: RequestOptions, mutation?: boolean): HeadersInit;
|
|
445
|
+
requestJson<T>(requestPath: string, config?: RequestConfig): Promise<T>;
|
|
446
|
+
fetchOrThrow(url: string, init: RequestInit, message: string): Promise<Response>;
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
type ListAgentsOptions = {
|
|
450
|
+
status?: string;
|
|
451
|
+
skip?: number;
|
|
452
|
+
limit?: number;
|
|
453
|
+
view?: "summary" | "full" | string;
|
|
454
|
+
};
|
|
455
|
+
declare class AgentsNamespace {
|
|
456
|
+
private readonly http;
|
|
457
|
+
constructor(http: Agents24HttpClient);
|
|
458
|
+
list(options?: ListAgentsOptions): Promise<AgentListResponse>;
|
|
459
|
+
get(agentId: string): Promise<AgentResponse>;
|
|
460
|
+
create(request: AgentCreateRequest, options?: RequestOptions): Promise<AgentResponse>;
|
|
461
|
+
update(agentId: string, request: AgentUpdateRequest, options?: RequestOptions): Promise<AgentResponse>;
|
|
462
|
+
updateGraph(agentId: string, graph: GraphDefinition, options?: RequestOptions): Promise<AgentResponse>;
|
|
463
|
+
delete(agentId: string, options?: RequestOptions): Promise<unknown>;
|
|
464
|
+
catalog(): Promise<Record<string, unknown>>;
|
|
465
|
+
schema(nodeTypes: string[]): Promise<Record<string, unknown>>;
|
|
466
|
+
validate(agentId: string): Promise<Record<string, unknown>>;
|
|
467
|
+
publish(agentId: string, options?: RequestOptions): Promise<AgentResponse>;
|
|
468
|
+
startRun(agentId: string, payload: AgentStreamRequest, options?: RequestOptions): Promise<StartRunResult>;
|
|
469
|
+
stream(agentId: string, payload: AgentStreamRequest, onEvent?: (event: RuntimeEvent) => void | Promise<void>, mode?: "debug" | "production" | string, options?: StreamRequestOptions): Promise<StreamResult>;
|
|
470
|
+
resumeRun(runId: string, payload: Record<string, unknown>, options?: RequestOptions): Promise<Record<string, unknown>>;
|
|
471
|
+
cancelRun(runId: string, options?: RunCancelOptions): Promise<RunCancelResult>;
|
|
472
|
+
uploadAttachments(agentId: string, options: ServerAttachmentUploadOptions): Promise<AttachmentUploadResult>;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
declare class AgentDefinitionBuilder {
|
|
476
|
+
private readonly agents;
|
|
477
|
+
private readonly options;
|
|
478
|
+
constructor(agents: AgentsNamespace, options: AgentDefinitionOptions);
|
|
479
|
+
toGraph(): GraphDefinition;
|
|
480
|
+
toCreateRequest(): AgentCreateRequest;
|
|
481
|
+
create(options?: RequestOptions): Promise<AgentResponse>;
|
|
482
|
+
}
|
|
483
|
+
declare class GraphBuilder {
|
|
484
|
+
private readonly nodes;
|
|
485
|
+
private readonly edges;
|
|
486
|
+
node(type: string, config?: Record<string, unknown>, options?: {
|
|
487
|
+
id?: string;
|
|
488
|
+
x?: number;
|
|
489
|
+
y?: number;
|
|
490
|
+
label?: string;
|
|
491
|
+
}): GraphNode;
|
|
492
|
+
connect(source: GraphNode | string, target: GraphNode | string, options?: {
|
|
493
|
+
id?: string;
|
|
494
|
+
sourceHandle?: string;
|
|
495
|
+
targetHandle?: string;
|
|
496
|
+
}): this;
|
|
497
|
+
toGraph(): GraphDefinition;
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
declare class ClientDeploymentsNamespace {
|
|
501
|
+
private readonly http;
|
|
502
|
+
constructor(http: Agents24HttpClient);
|
|
503
|
+
create(request: CreateClientDeploymentRequest, options?: RequestOptions): Promise<ClientDeployment>;
|
|
504
|
+
get(deploymentId: string): Promise<ClientDeployment>;
|
|
505
|
+
update(deploymentId: string, request: UpdateClientDeploymentRequest, options?: RequestOptions): Promise<ClientDeployment>;
|
|
506
|
+
promote(deploymentId: string, request: PromoteClientDeploymentRequest, options?: RequestOptions): Promise<ClientDeployment>;
|
|
507
|
+
revoke(deploymentId: string, options?: RequestOptions): Promise<ClientDeployment>;
|
|
508
|
+
}
|
|
509
|
+
declare class ClientSessionsNamespace {
|
|
510
|
+
private readonly http;
|
|
511
|
+
constructor(http: Agents24HttpClient);
|
|
512
|
+
createBackendSession(deploymentId: string, request: CreateBackendClientSessionRequest, options?: BackendSessionRequestOptions): Promise<ClientSessionCredentials>;
|
|
513
|
+
}
|
|
514
|
+
|
|
515
|
+
declare class EmbedNamespace {
|
|
516
|
+
private readonly http;
|
|
517
|
+
constructor(http: Agents24HttpClient);
|
|
518
|
+
streamAgent(agentId: string, payload: EmbedStreamRequest, onEvent?: (event: RuntimeEvent) => void | Promise<void>, options?: StreamRequestOptions): Promise<StreamResult>;
|
|
519
|
+
attachAgentRun(agentId: string, runId: string, payload: AttachRunRequest, onEvent?: (event: RuntimeEvent) => void | Promise<void>, options?: StreamRequestOptions): Promise<StreamResult>;
|
|
520
|
+
private stream;
|
|
521
|
+
resumeAgentRun(agentId: string, runId: string, payload: ResumeRunRequest, options?: RequestOptions): Promise<RunResumeResult>;
|
|
522
|
+
startAgentRunMcpAuth(agentId: string, runId: string, serverId: string, payload: McpAuthStartRequest, options?: RequestOptions): Promise<McpAuthStartResult>;
|
|
523
|
+
getRuntimeBootstrap(agentId: string): Promise<EmbedRuntimeBootstrap>;
|
|
524
|
+
listAgentThreads(agentId: string, options: ThreadListOptions): Promise<ThreadsResponse>;
|
|
525
|
+
listAgentThreadsMulti(options: MultiAgentThreadListRequest): Promise<ThreadsResponse>;
|
|
526
|
+
subscribeAgentThreadEvents(agentId: string, options: ThreadSummaryEventOptions, onEvent: (event: ThreadSummaryEvent) => void | Promise<void>): Promise<void>;
|
|
527
|
+
subscribeAgentThreadEventsMulti(options: MultiAgentThreadSummaryEventOptions, onEvent: (event: ThreadSummaryEvent) => void | Promise<void>): Promise<void>;
|
|
528
|
+
getAgentThread(agentId: string, threadId: string, options: ThreadDetailOptions): Promise<ThreadDetail>;
|
|
529
|
+
deleteAgentThread(agentId: string, threadId: string, options: ThreadDeleteOptions): Promise<ThreadDeleteResult>;
|
|
530
|
+
getAgentRunContext(agentId: string, runId: string, options: RunContextOptions): Promise<RunContext>;
|
|
531
|
+
cancelAgentRun(agentId: string, runId: string, options: EmbedRunCancelOptions): Promise<RunCancelResult>;
|
|
532
|
+
uploadAgentAttachments(agentId: string, options: ServerEmbedAttachmentUploadOptions): Promise<AttachmentUploadResult>;
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
declare class RunsNamespace {
|
|
536
|
+
private readonly http;
|
|
537
|
+
constructor(http: Agents24HttpClient);
|
|
538
|
+
get(runId: string, options?: {
|
|
539
|
+
includeTree?: boolean;
|
|
540
|
+
}): Promise<RunStatus>;
|
|
541
|
+
getTree(runId: string): Promise<Record<string, unknown>>;
|
|
542
|
+
getEvents(runId: string, options?: {
|
|
543
|
+
afterSequence?: number;
|
|
544
|
+
limit?: number;
|
|
545
|
+
}): Promise<ControlPlaneRunEventsResponse>;
|
|
546
|
+
getContext(runId: string): Promise<RunContext>;
|
|
547
|
+
getTrace(runId: string): Promise<RunTrace>;
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
declare class Agents24 {
|
|
551
|
+
readonly agents: AgentsNamespace;
|
|
552
|
+
readonly embed: EmbedNamespace;
|
|
553
|
+
readonly runs: RunsNamespace;
|
|
554
|
+
readonly clientDeployments: ClientDeploymentsNamespace;
|
|
555
|
+
readonly clientSessions: ClientSessionsNamespace;
|
|
556
|
+
constructor(options: Agents24NodeOptions);
|
|
557
|
+
agent(options: AgentDefinitionOptions): AgentDefinitionBuilder;
|
|
558
|
+
graph(): GraphBuilder;
|
|
559
|
+
}
|
|
560
|
+
|
|
561
|
+
declare const SDK_OPERATION_IDS: readonly ["agents.cancel_run", "agents.catalog", "agents.create", "agents.delete", "agents.get", "agents.list", "agents.publish", "agents.resume_run", "agents.schema", "agents.start_run", "agents.stream", "agents.update", "agents.update_graph", "agents.upload_attachments", "agents.validate", "client.attachments.upload", "client.bootstrap", "client.chat.stream", "client.deployments.create", "client.deployments.get", "client.deployments.promote", "client.deployments.revoke", "client.deployments.update", "client.hitl.resume", "client.jwks", "client.mcp.redeem", "client.mcp.start", "client.runs.attach", "client.runs.cancel", "client.sessions.anonymous", "client.sessions.backendExchange", "client.sessions.refresh", "client.sessions.revoke", "client.threads.delete", "client.threads.events", "client.threads.get", "client.threads.list", "embed.attach_agent_run", "embed.cancel_agent_run", "embed.delete_agent_thread", "embed.get_agent_run_context", "embed.get_agent_thread", "embed.get_runtime_bootstrap", "embed.list_agent_threads", "embed.list_agent_threads_multi", "embed.resume_agent_run", "embed.start_agent_run_mcp_auth", "embed.stream_agent", "embed.stream_agent_thread_events", "embed.stream_agent_thread_events_multi", "embed.upload_agent_attachments", "runs.get", "runs.get_context", "runs.get_events", "runs.get_tree"];
|
|
562
|
+
type SDKOperationId = (typeof SDK_OPERATION_IDS)[number];
|
|
563
|
+
|
|
564
|
+
export { type AgentCreateRequest, AgentDefinitionBuilder, type AgentDefinitionOptions, type AgentListResponse, type AgentRef, type AgentResponse, type AgentStreamRequest, type AgentToolsetAttachment, type AgentUpdateRequest, Agents24, Agents24SDKError as Agents24NodeError, type Agents24NodeErrorKind, type Agents24NodeOptions, type Agents24Options, Agents24SDKError, type Agents24SDKErrorKind, type Agents24SDKSerializedError, type AttachRunRequest, type BackendSessionRequestOptions, type ClientAuthMode, type ClientDeployment, type ClientNativeProfile, type ClientRuntimeNativeProfileInput, type ClientRuntimeOidcConfig, type ClientRuntimePolicyInput, type ClientSessionCredentials, type ControlPlaneRunEventsResponse, type CreateBackendClientSessionRequest, type CreateClientDeploymentRequest, type EmbedRunCancelOptions, type EmbedRuntimeBootstrap, type EmbedStreamRequest, GraphBuilder, type GraphDefinition, type GraphEdge, type GraphNode, type HitlAction, type LatestOrPinnedPolicy, type McpAuthStartRequest, type McpAuthStartResult, type MultiAgentThreadListRequest, type MultiAgentThreadSummaryEventOptions, type NativePlatform, type PromoteClientDeploymentRequest, type RequestOptions, type ResumeRunRequest, type RunCancelOptions, type RunContextOptions, type RunStatus, type RunTrace, type SDKOperationId, SDK_OPERATION_IDS, type ServerAttachmentUploadOptions, type ServerEmbedAttachmentUploadOptions, type StartRunResult, type StreamRequestOptions, type StreamResult, type ThreadDeleteOptions, type ThreadDetailOptions, type ThreadListOptions, type ThreadSummaryEventOptions, type UpdateClientDeploymentRequest };
|