@outputai/cli 0.1.12 → 0.1.13-dev.2f0a972.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/dist/api/generated/api.d.ts +322 -84
- package/dist/api/generated/api.js +67 -9
- package/dist/assets/docker/docker-compose-dev.yml +1 -1
- package/dist/commands/workflow/generate.js +3 -1
- package/dist/commands/workflow/generate.spec.js +12 -0
- package/dist/commands/workflow/list.d.ts +1 -0
- package/dist/commands/workflow/list.js +12 -6
- package/dist/commands/workflow/list.spec.js +21 -0
- package/dist/commands/workflow/run.js +2 -1
- package/dist/commands/workflow/run.spec.js +1 -0
- package/dist/commands/workflow/start.js +2 -1
- package/dist/commands/workflow/start.spec.js +1 -0
- package/dist/commands/workflow/test_eval.js +2 -2
- package/dist/components/command_footer.d.ts +8 -0
- package/dist/components/command_footer.js +4 -0
- package/dist/components/status_icon.d.ts +11 -0
- package/dist/components/status_icon.js +25 -0
- package/dist/components/workflow_summary.d.ts +10 -0
- package/dist/components/workflow_summary.js +4 -0
- package/dist/generated/framework_version.json +1 -1
- package/dist/services/claude_client.js +4 -1
- package/dist/services/datasets.d.ts +1 -1
- package/dist/services/datasets.js +41 -37
- package/dist/services/datasets.test.d.ts +1 -0
- package/dist/services/datasets.test.js +202 -0
- package/dist/services/docker.d.ts +1 -3
- package/dist/services/docker.js +38 -13
- package/dist/services/messages.d.ts +1 -1
- package/dist/services/messages.js +2 -2
- package/dist/templates/agent_instructions/CLAUDE.md.template +36 -2
- package/dist/templates/agent_instructions/dotclaude/settings.json.template +2 -2
- package/dist/utils/date_formatter.d.ts +11 -1
- package/dist/utils/date_formatter.js +26 -1
- package/dist/utils/format_workflow_result.d.ts +3 -3
- package/dist/utils/open_url.d.ts +1 -0
- package/dist/utils/open_url.js +12 -0
- package/dist/utils/workflow_dir_parser.d.ts +5 -0
- package/dist/utils/workflow_dir_parser.js +39 -0
- package/dist/utils/workflow_dir_parser.spec.d.ts +1 -0
- package/dist/utils/workflow_dir_parser.spec.js +74 -0
- package/dist/views/dev.js +62 -26
- package/dist/views/workflow/list.d.ts +6 -0
- package/dist/views/workflow/list.js +127 -0
- package/package.json +14 -14
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generated by orval v8.
|
|
2
|
+
* Generated by orval v8.8.0 🍺
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* Output.ai API
|
|
5
5
|
* API for managing and executing Output.ai workflows
|
|
@@ -63,6 +63,8 @@ export interface Workflow {
|
|
|
63
63
|
path?: string;
|
|
64
64
|
inputSchema?: JSONSchema;
|
|
65
65
|
outputSchema?: JSONSchema;
|
|
66
|
+
/** Alternative names that resolve to this workflow */
|
|
67
|
+
aliases?: string[];
|
|
66
68
|
}
|
|
67
69
|
/**
|
|
68
70
|
* File destinations for trace data
|
|
@@ -125,6 +127,8 @@ export declare const TraceLogRemoteResponseSource: {
|
|
|
125
127
|
export interface TraceLogRemoteResponse {
|
|
126
128
|
/** Indicates trace was fetched from remote storage */
|
|
127
129
|
source: TraceLogRemoteResponseSource;
|
|
130
|
+
/** The specific run id this trace belongs to */
|
|
131
|
+
runId: string;
|
|
128
132
|
data: TraceData;
|
|
129
133
|
}
|
|
130
134
|
/**
|
|
@@ -137,6 +141,8 @@ export declare const TraceLogLocalResponseSource: {
|
|
|
137
141
|
export interface TraceLogLocalResponse {
|
|
138
142
|
/** Indicates trace is available locally */
|
|
139
143
|
source: TraceLogLocalResponseSource;
|
|
144
|
+
/** The specific run id this trace belongs to */
|
|
145
|
+
runId: string;
|
|
140
146
|
/** Absolute path to local trace file */
|
|
141
147
|
localPath: string;
|
|
142
148
|
}
|
|
@@ -173,6 +179,83 @@ export interface WorkflowRunsResponse {
|
|
|
173
179
|
/** Total number of runs returned */
|
|
174
180
|
count?: number;
|
|
175
181
|
}
|
|
182
|
+
/**
|
|
183
|
+
* The workflow execution status
|
|
184
|
+
*/
|
|
185
|
+
export type WorkflowStatusResponseStatus = typeof WorkflowStatusResponseStatus[keyof typeof WorkflowStatusResponseStatus];
|
|
186
|
+
export declare const WorkflowStatusResponseStatus: {
|
|
187
|
+
readonly canceled: "canceled";
|
|
188
|
+
readonly completed: "completed";
|
|
189
|
+
readonly continued_as_new: "continued_as_new";
|
|
190
|
+
readonly failed: "failed";
|
|
191
|
+
readonly running: "running";
|
|
192
|
+
readonly terminated: "terminated";
|
|
193
|
+
readonly timed_out: "timed_out";
|
|
194
|
+
readonly unspecified: "unspecified";
|
|
195
|
+
};
|
|
196
|
+
export interface WorkflowStatusResponse {
|
|
197
|
+
/** The id of workflow */
|
|
198
|
+
workflowId?: string;
|
|
199
|
+
/** The specific run id for this execution */
|
|
200
|
+
runId?: string;
|
|
201
|
+
/** The workflow execution status */
|
|
202
|
+
status?: WorkflowStatusResponseStatus;
|
|
203
|
+
/** An epoch timestamp representing when the workflow started */
|
|
204
|
+
startedAt?: number;
|
|
205
|
+
/** An epoch timestamp representing when the workflow ended */
|
|
206
|
+
completedAt?: number;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* The workflow execution status
|
|
210
|
+
*/
|
|
211
|
+
export type WorkflowResultResponseStatus = typeof WorkflowResultResponseStatus[keyof typeof WorkflowResultResponseStatus];
|
|
212
|
+
export declare const WorkflowResultResponseStatus: {
|
|
213
|
+
readonly completed: "completed";
|
|
214
|
+
readonly failed: "failed";
|
|
215
|
+
readonly canceled: "canceled";
|
|
216
|
+
readonly terminated: "terminated";
|
|
217
|
+
readonly timed_out: "timed_out";
|
|
218
|
+
readonly continued: "continued";
|
|
219
|
+
};
|
|
220
|
+
export interface WorkflowResultResponse {
|
|
221
|
+
/** The workflow execution id */
|
|
222
|
+
workflowId?: string;
|
|
223
|
+
/** The specific run id for this execution */
|
|
224
|
+
runId?: string;
|
|
225
|
+
/** The original input passed to the workflow, null if unavailable */
|
|
226
|
+
input?: unknown;
|
|
227
|
+
/** The result of workflow, null if workflow failed */
|
|
228
|
+
output?: unknown;
|
|
229
|
+
trace?: TraceInfo;
|
|
230
|
+
/** The workflow execution status */
|
|
231
|
+
status?: WorkflowResultResponseStatus;
|
|
232
|
+
/**
|
|
233
|
+
* Error message if workflow failed, null otherwise
|
|
234
|
+
* @nullable
|
|
235
|
+
*/
|
|
236
|
+
error?: string | null;
|
|
237
|
+
}
|
|
238
|
+
export interface StopWorkflowResponse {
|
|
239
|
+
workflowId?: string;
|
|
240
|
+
runId?: string;
|
|
241
|
+
}
|
|
242
|
+
export interface TerminateWorkflowResponse {
|
|
243
|
+
terminated?: boolean;
|
|
244
|
+
workflowId?: string;
|
|
245
|
+
runId?: string;
|
|
246
|
+
}
|
|
247
|
+
export interface ResetWorkflowRequest {
|
|
248
|
+
/** The name of the step to reset after */
|
|
249
|
+
stepName: string;
|
|
250
|
+
/** Optional reason for the reset */
|
|
251
|
+
reason?: string;
|
|
252
|
+
}
|
|
253
|
+
export interface ResetWorkflowResponse {
|
|
254
|
+
/** The original workflow ID */
|
|
255
|
+
workflowId?: string;
|
|
256
|
+
/** The run ID of the new execution created by the reset */
|
|
257
|
+
runId?: string;
|
|
258
|
+
}
|
|
176
259
|
/**
|
|
177
260
|
* Invalid request body or query (validation failed)
|
|
178
261
|
*/
|
|
@@ -189,6 +272,10 @@ export type RequestTimeoutResponse = ErrorResponse;
|
|
|
189
272
|
* Workflow not in a terminal state (still running)
|
|
190
273
|
*/
|
|
191
274
|
export type FailedDependencyResponse = ErrorResponse;
|
|
275
|
+
/**
|
|
276
|
+
* Workflow run is in a state that conflicts with the requested operation (e.g. operating on an already-terminal run, or resetting to an incomplete step).
|
|
277
|
+
*/
|
|
278
|
+
export type ConflictResponse = ErrorResponse;
|
|
192
279
|
/**
|
|
193
280
|
* Catalog workflow unavailable (worker not running or still starting). Retry-After header may be set.
|
|
194
281
|
*/
|
|
@@ -244,77 +331,19 @@ export type PostWorkflowStartBody = {
|
|
|
244
331
|
export type PostWorkflowStart200 = {
|
|
245
332
|
/** The id of the started workflow */
|
|
246
333
|
workflowId?: string;
|
|
334
|
+
/**
|
|
335
|
+
* The first execution's run id for this workflow
|
|
336
|
+
* @nullable
|
|
337
|
+
*/
|
|
338
|
+
runId?: string | null;
|
|
247
339
|
};
|
|
248
|
-
|
|
249
|
-
* The workflow execution status
|
|
250
|
-
*/
|
|
251
|
-
export type GetWorkflowIdStatus200Status = typeof GetWorkflowIdStatus200Status[keyof typeof GetWorkflowIdStatus200Status];
|
|
252
|
-
export declare const GetWorkflowIdStatus200Status: {
|
|
253
|
-
readonly canceled: "canceled";
|
|
254
|
-
readonly completed: "completed";
|
|
255
|
-
readonly continued_as_new: "continued_as_new";
|
|
256
|
-
readonly failed: "failed";
|
|
257
|
-
readonly running: "running";
|
|
258
|
-
readonly terminated: "terminated";
|
|
259
|
-
readonly timed_out: "timed_out";
|
|
260
|
-
readonly unspecified: "unspecified";
|
|
261
|
-
};
|
|
262
|
-
export type GetWorkflowIdStatus200 = {
|
|
263
|
-
/** The id of workflow */
|
|
264
|
-
workflowId?: string;
|
|
265
|
-
/** The workflow execution status */
|
|
266
|
-
status?: GetWorkflowIdStatus200Status;
|
|
267
|
-
/** An epoch timestamp representing when the workflow started */
|
|
268
|
-
startedAt?: number;
|
|
269
|
-
/** An epoch timestamp representing when the workflow ended */
|
|
270
|
-
completedAt?: number;
|
|
271
|
-
};
|
|
272
|
-
export type PostWorkflowIdTerminateBody = {
|
|
340
|
+
export type PostWorkflowIdRunsRidTerminateBody = {
|
|
273
341
|
/** Optional reason for termination */
|
|
274
342
|
reason?: string;
|
|
275
343
|
};
|
|
276
|
-
export type
|
|
277
|
-
terminated?: boolean;
|
|
278
|
-
workflowId?: string;
|
|
279
|
-
};
|
|
280
|
-
export type PostWorkflowIdResetBody = {
|
|
281
|
-
/** The name of the step to reset after */
|
|
282
|
-
stepName: string;
|
|
283
|
-
/** Optional reason for the reset */
|
|
344
|
+
export type PostWorkflowIdTerminateBody = {
|
|
284
345
|
reason?: string;
|
|
285
346
|
};
|
|
286
|
-
export type PostWorkflowIdReset200 = {
|
|
287
|
-
/** The original workflow ID */
|
|
288
|
-
workflowId?: string;
|
|
289
|
-
/** The run ID of the new execution created by the reset */
|
|
290
|
-
runId?: string;
|
|
291
|
-
};
|
|
292
|
-
/**
|
|
293
|
-
* The workflow execution status
|
|
294
|
-
*/
|
|
295
|
-
export type GetWorkflowIdResult200Status = typeof GetWorkflowIdResult200Status[keyof typeof GetWorkflowIdResult200Status];
|
|
296
|
-
export declare const GetWorkflowIdResult200Status: {
|
|
297
|
-
readonly completed: "completed";
|
|
298
|
-
readonly failed: "failed";
|
|
299
|
-
readonly canceled: "canceled";
|
|
300
|
-
readonly terminated: "terminated";
|
|
301
|
-
readonly timed_out: "timed_out";
|
|
302
|
-
readonly continued: "continued";
|
|
303
|
-
};
|
|
304
|
-
export type GetWorkflowIdResult200 = {
|
|
305
|
-
/** The workflow execution id */
|
|
306
|
-
workflowId?: string;
|
|
307
|
-
/** The result of workflow, null if workflow failed */
|
|
308
|
-
output?: unknown;
|
|
309
|
-
trace?: TraceInfo;
|
|
310
|
-
/** The workflow execution status */
|
|
311
|
-
status?: GetWorkflowIdResult200Status;
|
|
312
|
-
/**
|
|
313
|
-
* Error message if workflow failed, null otherwise
|
|
314
|
-
* @nullable
|
|
315
|
-
*/
|
|
316
|
-
error?: string | null;
|
|
317
|
-
};
|
|
318
347
|
export type GetWorkflowCatalogId200 = {
|
|
319
348
|
/** Each workflow available in this catalog */
|
|
320
349
|
workflows?: Workflow[];
|
|
@@ -454,10 +483,11 @@ export type postWorkflowStartResponse = (postWorkflowStartResponseSuccess | post
|
|
|
454
483
|
export declare const getPostWorkflowStartUrl: () => string;
|
|
455
484
|
export declare const postWorkflowStart: (postWorkflowStartBody: PostWorkflowStartBody, options?: ApiRequestOptions) => Promise<postWorkflowStartResponse>;
|
|
456
485
|
/**
|
|
457
|
-
*
|
|
486
|
+
* Returns the status of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/status`.
|
|
487
|
+
* @summary Get workflow execution status (latest run)
|
|
458
488
|
*/
|
|
459
489
|
export type getWorkflowIdStatusResponse200 = {
|
|
460
|
-
data:
|
|
490
|
+
data: WorkflowStatusResponse;
|
|
461
491
|
status: 200;
|
|
462
492
|
};
|
|
463
493
|
export type getWorkflowIdStatusResponse404 = {
|
|
@@ -478,16 +508,82 @@ export type getWorkflowIdStatusResponse = (getWorkflowIdStatusResponseSuccess |
|
|
|
478
508
|
export declare const getGetWorkflowIdStatusUrl: (id: string) => string;
|
|
479
509
|
export declare const getWorkflowIdStatus: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdStatusResponse>;
|
|
480
510
|
/**
|
|
481
|
-
* @summary
|
|
511
|
+
* @summary Get workflow execution status for a specific run
|
|
512
|
+
*/
|
|
513
|
+
export type getWorkflowIdRunsRidStatusResponse200 = {
|
|
514
|
+
data: WorkflowStatusResponse;
|
|
515
|
+
status: 200;
|
|
516
|
+
};
|
|
517
|
+
export type getWorkflowIdRunsRidStatusResponse400 = {
|
|
518
|
+
data: BadRequestResponse;
|
|
519
|
+
status: 400;
|
|
520
|
+
};
|
|
521
|
+
export type getWorkflowIdRunsRidStatusResponse404 = {
|
|
522
|
+
data: NotFoundResponse;
|
|
523
|
+
status: 404;
|
|
524
|
+
};
|
|
525
|
+
export type getWorkflowIdRunsRidStatusResponse500 = {
|
|
526
|
+
data: InternalServerErrorResponse;
|
|
527
|
+
status: 500;
|
|
528
|
+
};
|
|
529
|
+
export type getWorkflowIdRunsRidStatusResponseSuccess = (getWorkflowIdRunsRidStatusResponse200) & {
|
|
530
|
+
headers: Headers;
|
|
531
|
+
};
|
|
532
|
+
export type getWorkflowIdRunsRidStatusResponseError = (getWorkflowIdRunsRidStatusResponse400 | getWorkflowIdRunsRidStatusResponse404 | getWorkflowIdRunsRidStatusResponse500) & {
|
|
533
|
+
headers: Headers;
|
|
534
|
+
};
|
|
535
|
+
export type getWorkflowIdRunsRidStatusResponse = (getWorkflowIdRunsRidStatusResponseSuccess | getWorkflowIdRunsRidStatusResponseError);
|
|
536
|
+
export declare const getGetWorkflowIdRunsRidStatusUrl: (id: string, rid: string) => string;
|
|
537
|
+
export declare const getWorkflowIdRunsRidStatus: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidStatusResponse>;
|
|
538
|
+
/**
|
|
539
|
+
* @summary Stop a specific workflow run
|
|
540
|
+
*/
|
|
541
|
+
export type patchWorkflowIdRunsRidStopResponse200 = {
|
|
542
|
+
data: StopWorkflowResponse;
|
|
543
|
+
status: 200;
|
|
544
|
+
};
|
|
545
|
+
export type patchWorkflowIdRunsRidStopResponse400 = {
|
|
546
|
+
data: BadRequestResponse;
|
|
547
|
+
status: 400;
|
|
548
|
+
};
|
|
549
|
+
export type patchWorkflowIdRunsRidStopResponse404 = {
|
|
550
|
+
data: NotFoundResponse;
|
|
551
|
+
status: 404;
|
|
552
|
+
};
|
|
553
|
+
export type patchWorkflowIdRunsRidStopResponse409 = {
|
|
554
|
+
data: ConflictResponse;
|
|
555
|
+
status: 409;
|
|
556
|
+
};
|
|
557
|
+
export type patchWorkflowIdRunsRidStopResponse500 = {
|
|
558
|
+
data: InternalServerErrorResponse;
|
|
559
|
+
status: 500;
|
|
560
|
+
};
|
|
561
|
+
export type patchWorkflowIdRunsRidStopResponseSuccess = (patchWorkflowIdRunsRidStopResponse200) & {
|
|
562
|
+
headers: Headers;
|
|
563
|
+
};
|
|
564
|
+
export type patchWorkflowIdRunsRidStopResponseError = (patchWorkflowIdRunsRidStopResponse400 | patchWorkflowIdRunsRidStopResponse404 | patchWorkflowIdRunsRidStopResponse409 | patchWorkflowIdRunsRidStopResponse500) & {
|
|
565
|
+
headers: Headers;
|
|
566
|
+
};
|
|
567
|
+
export type patchWorkflowIdRunsRidStopResponse = (patchWorkflowIdRunsRidStopResponseSuccess | patchWorkflowIdRunsRidStopResponseError);
|
|
568
|
+
export declare const getPatchWorkflowIdRunsRidStopUrl: (id: string, rid: string) => string;
|
|
569
|
+
export declare const patchWorkflowIdRunsRidStop: (id: string, rid: string, options?: ApiRequestOptions) => Promise<patchWorkflowIdRunsRidStopResponse>;
|
|
570
|
+
/**
|
|
571
|
+
* Stops the latest run of the given workflow. The returned `runId` reflects the run at describe-time and may differ from the cancelled run if a new execution started concurrently. Deprecated; use `PATCH /workflow/{id}/runs/{rid}/stop` to pin a specific run. Scheduled for removal after 2026-07-16.
|
|
572
|
+
* @deprecated
|
|
573
|
+
* @summary [Deprecated] Stop the latest workflow run
|
|
482
574
|
*/
|
|
483
575
|
export type patchWorkflowIdStopResponse200 = {
|
|
484
|
-
data:
|
|
576
|
+
data: StopWorkflowResponse;
|
|
485
577
|
status: 200;
|
|
486
578
|
};
|
|
487
579
|
export type patchWorkflowIdStopResponse404 = {
|
|
488
580
|
data: NotFoundResponse;
|
|
489
581
|
status: 404;
|
|
490
582
|
};
|
|
583
|
+
export type patchWorkflowIdStopResponse409 = {
|
|
584
|
+
data: ConflictResponse;
|
|
585
|
+
status: 409;
|
|
586
|
+
};
|
|
491
587
|
export type patchWorkflowIdStopResponse500 = {
|
|
492
588
|
data: InternalServerErrorResponse;
|
|
493
589
|
status: 500;
|
|
@@ -495,18 +591,52 @@ export type patchWorkflowIdStopResponse500 = {
|
|
|
495
591
|
export type patchWorkflowIdStopResponseSuccess = (patchWorkflowIdStopResponse200) & {
|
|
496
592
|
headers: Headers;
|
|
497
593
|
};
|
|
498
|
-
export type patchWorkflowIdStopResponseError = (patchWorkflowIdStopResponse404 | patchWorkflowIdStopResponse500) & {
|
|
594
|
+
export type patchWorkflowIdStopResponseError = (patchWorkflowIdStopResponse404 | patchWorkflowIdStopResponse409 | patchWorkflowIdStopResponse500) & {
|
|
499
595
|
headers: Headers;
|
|
500
596
|
};
|
|
501
597
|
export type patchWorkflowIdStopResponse = (patchWorkflowIdStopResponseSuccess | patchWorkflowIdStopResponseError);
|
|
502
598
|
export declare const getPatchWorkflowIdStopUrl: (id: string) => string;
|
|
503
599
|
export declare const patchWorkflowIdStop: (id: string, options?: ApiRequestOptions) => Promise<patchWorkflowIdStopResponse>;
|
|
504
600
|
/**
|
|
505
|
-
* Force terminates a workflow. Unlike stop/cancel, terminate immediately stops the
|
|
506
|
-
* @summary Terminate a workflow
|
|
601
|
+
* Force terminates a workflow run. Unlike stop/cancel, terminate immediately stops the run without allowing cleanup.
|
|
602
|
+
* @summary Terminate a specific workflow run (force stop)
|
|
603
|
+
*/
|
|
604
|
+
export type postWorkflowIdRunsRidTerminateResponse200 = {
|
|
605
|
+
data: TerminateWorkflowResponse;
|
|
606
|
+
status: 200;
|
|
607
|
+
};
|
|
608
|
+
export type postWorkflowIdRunsRidTerminateResponse400 = {
|
|
609
|
+
data: BadRequestResponse;
|
|
610
|
+
status: 400;
|
|
611
|
+
};
|
|
612
|
+
export type postWorkflowIdRunsRidTerminateResponse404 = {
|
|
613
|
+
data: NotFoundResponse;
|
|
614
|
+
status: 404;
|
|
615
|
+
};
|
|
616
|
+
export type postWorkflowIdRunsRidTerminateResponse409 = {
|
|
617
|
+
data: ConflictResponse;
|
|
618
|
+
status: 409;
|
|
619
|
+
};
|
|
620
|
+
export type postWorkflowIdRunsRidTerminateResponse500 = {
|
|
621
|
+
data: InternalServerErrorResponse;
|
|
622
|
+
status: 500;
|
|
623
|
+
};
|
|
624
|
+
export type postWorkflowIdRunsRidTerminateResponseSuccess = (postWorkflowIdRunsRidTerminateResponse200) & {
|
|
625
|
+
headers: Headers;
|
|
626
|
+
};
|
|
627
|
+
export type postWorkflowIdRunsRidTerminateResponseError = (postWorkflowIdRunsRidTerminateResponse400 | postWorkflowIdRunsRidTerminateResponse404 | postWorkflowIdRunsRidTerminateResponse409 | postWorkflowIdRunsRidTerminateResponse500) & {
|
|
628
|
+
headers: Headers;
|
|
629
|
+
};
|
|
630
|
+
export type postWorkflowIdRunsRidTerminateResponse = (postWorkflowIdRunsRidTerminateResponseSuccess | postWorkflowIdRunsRidTerminateResponseError);
|
|
631
|
+
export declare const getPostWorkflowIdRunsRidTerminateUrl: (id: string, rid: string) => string;
|
|
632
|
+
export declare const postWorkflowIdRunsRidTerminate: (id: string, rid: string, postWorkflowIdRunsRidTerminateBody: PostWorkflowIdRunsRidTerminateBody, options?: ApiRequestOptions) => Promise<postWorkflowIdRunsRidTerminateResponse>;
|
|
633
|
+
/**
|
|
634
|
+
* Force terminates the latest run. Deprecated; use `POST /workflow/{id}/runs/{rid}/terminate` to target a specific run. Scheduled for removal after 2026-07-16.
|
|
635
|
+
* @deprecated
|
|
636
|
+
* @summary [Deprecated] Terminate the latest workflow run
|
|
507
637
|
*/
|
|
508
638
|
export type postWorkflowIdTerminateResponse200 = {
|
|
509
|
-
data:
|
|
639
|
+
data: TerminateWorkflowResponse;
|
|
510
640
|
status: 200;
|
|
511
641
|
};
|
|
512
642
|
export type postWorkflowIdTerminateResponse400 = {
|
|
@@ -517,6 +647,10 @@ export type postWorkflowIdTerminateResponse404 = {
|
|
|
517
647
|
data: NotFoundResponse;
|
|
518
648
|
status: 404;
|
|
519
649
|
};
|
|
650
|
+
export type postWorkflowIdTerminateResponse409 = {
|
|
651
|
+
data: ConflictResponse;
|
|
652
|
+
status: 409;
|
|
653
|
+
};
|
|
520
654
|
export type postWorkflowIdTerminateResponse500 = {
|
|
521
655
|
data: InternalServerErrorResponse;
|
|
522
656
|
status: 500;
|
|
@@ -524,18 +658,52 @@ export type postWorkflowIdTerminateResponse500 = {
|
|
|
524
658
|
export type postWorkflowIdTerminateResponseSuccess = (postWorkflowIdTerminateResponse200) & {
|
|
525
659
|
headers: Headers;
|
|
526
660
|
};
|
|
527
|
-
export type postWorkflowIdTerminateResponseError = (postWorkflowIdTerminateResponse400 | postWorkflowIdTerminateResponse404 | postWorkflowIdTerminateResponse500) & {
|
|
661
|
+
export type postWorkflowIdTerminateResponseError = (postWorkflowIdTerminateResponse400 | postWorkflowIdTerminateResponse404 | postWorkflowIdTerminateResponse409 | postWorkflowIdTerminateResponse500) & {
|
|
528
662
|
headers: Headers;
|
|
529
663
|
};
|
|
530
664
|
export type postWorkflowIdTerminateResponse = (postWorkflowIdTerminateResponseSuccess | postWorkflowIdTerminateResponseError);
|
|
531
665
|
export declare const getPostWorkflowIdTerminateUrl: (id: string) => string;
|
|
532
666
|
export declare const postWorkflowIdTerminate: (id: string, postWorkflowIdTerminateBody: PostWorkflowIdTerminateBody, options?: ApiRequestOptions) => Promise<postWorkflowIdTerminateResponse>;
|
|
533
667
|
/**
|
|
534
|
-
* Resets a workflow
|
|
535
|
-
* @summary Reset a workflow to re-run from after a
|
|
668
|
+
* Resets a pinned workflow run to the point after a completed step, creating a new run that replays from that point. The current execution is terminated.
|
|
669
|
+
* @summary Reset a specific workflow run to re-run from after a completed step
|
|
670
|
+
*/
|
|
671
|
+
export type postWorkflowIdRunsRidResetResponse200 = {
|
|
672
|
+
data: ResetWorkflowResponse;
|
|
673
|
+
status: 200;
|
|
674
|
+
};
|
|
675
|
+
export type postWorkflowIdRunsRidResetResponse400 = {
|
|
676
|
+
data: BadRequestResponse;
|
|
677
|
+
status: 400;
|
|
678
|
+
};
|
|
679
|
+
export type postWorkflowIdRunsRidResetResponse404 = {
|
|
680
|
+
data: NotFoundResponse;
|
|
681
|
+
status: 404;
|
|
682
|
+
};
|
|
683
|
+
export type postWorkflowIdRunsRidResetResponse409 = {
|
|
684
|
+
data: ConflictResponse;
|
|
685
|
+
status: 409;
|
|
686
|
+
};
|
|
687
|
+
export type postWorkflowIdRunsRidResetResponse500 = {
|
|
688
|
+
data: InternalServerErrorResponse;
|
|
689
|
+
status: 500;
|
|
690
|
+
};
|
|
691
|
+
export type postWorkflowIdRunsRidResetResponseSuccess = (postWorkflowIdRunsRidResetResponse200) & {
|
|
692
|
+
headers: Headers;
|
|
693
|
+
};
|
|
694
|
+
export type postWorkflowIdRunsRidResetResponseError = (postWorkflowIdRunsRidResetResponse400 | postWorkflowIdRunsRidResetResponse404 | postWorkflowIdRunsRidResetResponse409 | postWorkflowIdRunsRidResetResponse500) & {
|
|
695
|
+
headers: Headers;
|
|
696
|
+
};
|
|
697
|
+
export type postWorkflowIdRunsRidResetResponse = (postWorkflowIdRunsRidResetResponseSuccess | postWorkflowIdRunsRidResetResponseError);
|
|
698
|
+
export declare const getPostWorkflowIdRunsRidResetUrl: (id: string, rid: string) => string;
|
|
699
|
+
export declare const postWorkflowIdRunsRidReset: (id: string, rid: string, resetWorkflowRequest: ResetWorkflowRequest, options?: ApiRequestOptions) => Promise<postWorkflowIdRunsRidResetResponse>;
|
|
700
|
+
/**
|
|
701
|
+
* Resets the latest run. Deprecated; use `POST /workflow/{id}/runs/{rid}/reset` to target a specific run. Scheduled for removal after 2026-07-16.
|
|
702
|
+
* @deprecated
|
|
703
|
+
* @summary [Deprecated] Reset the latest workflow run
|
|
536
704
|
*/
|
|
537
705
|
export type postWorkflowIdResetResponse200 = {
|
|
538
|
-
data:
|
|
706
|
+
data: ResetWorkflowResponse;
|
|
539
707
|
status: 200;
|
|
540
708
|
};
|
|
541
709
|
export type postWorkflowIdResetResponse400 = {
|
|
@@ -547,7 +715,7 @@ export type postWorkflowIdResetResponse404 = {
|
|
|
547
715
|
status: 404;
|
|
548
716
|
};
|
|
549
717
|
export type postWorkflowIdResetResponse409 = {
|
|
550
|
-
data:
|
|
718
|
+
data: ConflictResponse;
|
|
551
719
|
status: 409;
|
|
552
720
|
};
|
|
553
721
|
export type postWorkflowIdResetResponse500 = {
|
|
@@ -562,12 +730,13 @@ export type postWorkflowIdResetResponseError = (postWorkflowIdResetResponse400 |
|
|
|
562
730
|
};
|
|
563
731
|
export type postWorkflowIdResetResponse = (postWorkflowIdResetResponseSuccess | postWorkflowIdResetResponseError);
|
|
564
732
|
export declare const getPostWorkflowIdResetUrl: (id: string) => string;
|
|
565
|
-
export declare const postWorkflowIdReset: (id: string,
|
|
733
|
+
export declare const postWorkflowIdReset: (id: string, resetWorkflowRequest: ResetWorkflowRequest, options?: ApiRequestOptions) => Promise<postWorkflowIdResetResponse>;
|
|
566
734
|
/**
|
|
567
|
-
*
|
|
735
|
+
* Returns the result of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/result`.
|
|
736
|
+
* @summary Return the result of a workflow (latest run)
|
|
568
737
|
*/
|
|
569
738
|
export type getWorkflowIdResultResponse200 = {
|
|
570
|
-
data:
|
|
739
|
+
data: WorkflowResultResponse;
|
|
571
740
|
status: 200;
|
|
572
741
|
};
|
|
573
742
|
export type getWorkflowIdResultResponse404 = {
|
|
@@ -592,8 +761,40 @@ export type getWorkflowIdResultResponse = (getWorkflowIdResultResponseSuccess |
|
|
|
592
761
|
export declare const getGetWorkflowIdResultUrl: (id: string) => string;
|
|
593
762
|
export declare const getWorkflowIdResult: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdResultResponse>;
|
|
594
763
|
/**
|
|
595
|
-
*
|
|
596
|
-
|
|
764
|
+
* @summary Return the result of a specific workflow run
|
|
765
|
+
*/
|
|
766
|
+
export type getWorkflowIdRunsRidResultResponse200 = {
|
|
767
|
+
data: WorkflowResultResponse;
|
|
768
|
+
status: 200;
|
|
769
|
+
};
|
|
770
|
+
export type getWorkflowIdRunsRidResultResponse400 = {
|
|
771
|
+
data: BadRequestResponse;
|
|
772
|
+
status: 400;
|
|
773
|
+
};
|
|
774
|
+
export type getWorkflowIdRunsRidResultResponse404 = {
|
|
775
|
+
data: NotFoundResponse;
|
|
776
|
+
status: 404;
|
|
777
|
+
};
|
|
778
|
+
export type getWorkflowIdRunsRidResultResponse424 = {
|
|
779
|
+
data: FailedDependencyResponse;
|
|
780
|
+
status: 424;
|
|
781
|
+
};
|
|
782
|
+
export type getWorkflowIdRunsRidResultResponse500 = {
|
|
783
|
+
data: InternalServerErrorResponse;
|
|
784
|
+
status: 500;
|
|
785
|
+
};
|
|
786
|
+
export type getWorkflowIdRunsRidResultResponseSuccess = (getWorkflowIdRunsRidResultResponse200) & {
|
|
787
|
+
headers: Headers;
|
|
788
|
+
};
|
|
789
|
+
export type getWorkflowIdRunsRidResultResponseError = (getWorkflowIdRunsRidResultResponse400 | getWorkflowIdRunsRidResultResponse404 | getWorkflowIdRunsRidResultResponse424 | getWorkflowIdRunsRidResultResponse500) & {
|
|
790
|
+
headers: Headers;
|
|
791
|
+
};
|
|
792
|
+
export type getWorkflowIdRunsRidResultResponse = (getWorkflowIdRunsRidResultResponseSuccess | getWorkflowIdRunsRidResultResponseError);
|
|
793
|
+
export declare const getGetWorkflowIdRunsRidResultUrl: (id: string, rid: string) => string;
|
|
794
|
+
export declare const getWorkflowIdRunsRidResult: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidResultResponse>;
|
|
795
|
+
/**
|
|
796
|
+
* Returns trace data for the latest run of the given workflow. If trace is stored remotely (S3), fetches and returns the data inline. If trace is local only, returns the local path. To pin a specific run, use `/workflow/{id}/runs/{rid}/trace-log`.
|
|
797
|
+
* @summary Get workflow trace log data (latest run)
|
|
597
798
|
*/
|
|
598
799
|
export type getWorkflowIdTraceLogResponse200 = {
|
|
599
800
|
data: TraceLogRemoteResponse | TraceLogLocalResponse;
|
|
@@ -620,6 +821,39 @@ export type getWorkflowIdTraceLogResponseError = (getWorkflowIdTraceLogResponse4
|
|
|
620
821
|
export type getWorkflowIdTraceLogResponse = (getWorkflowIdTraceLogResponseSuccess | getWorkflowIdTraceLogResponseError);
|
|
621
822
|
export declare const getGetWorkflowIdTraceLogUrl: (id: string) => string;
|
|
622
823
|
export declare const getWorkflowIdTraceLog: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdTraceLogResponse>;
|
|
824
|
+
/**
|
|
825
|
+
* Returns trace data for a pinned workflow run. If trace is stored remotely (S3), fetches and returns the data inline. If trace is local only, returns the local path.
|
|
826
|
+
* @summary Get workflow trace log data for a specific run
|
|
827
|
+
*/
|
|
828
|
+
export type getWorkflowIdRunsRidTraceLogResponse200 = {
|
|
829
|
+
data: TraceLogRemoteResponse | TraceLogLocalResponse;
|
|
830
|
+
status: 200;
|
|
831
|
+
};
|
|
832
|
+
export type getWorkflowIdRunsRidTraceLogResponse400 = {
|
|
833
|
+
data: BadRequestResponse;
|
|
834
|
+
status: 400;
|
|
835
|
+
};
|
|
836
|
+
export type getWorkflowIdRunsRidTraceLogResponse404 = {
|
|
837
|
+
data: NotFoundResponse;
|
|
838
|
+
status: 404;
|
|
839
|
+
};
|
|
840
|
+
export type getWorkflowIdRunsRidTraceLogResponse424 = {
|
|
841
|
+
data: FailedDependencyResponse;
|
|
842
|
+
status: 424;
|
|
843
|
+
};
|
|
844
|
+
export type getWorkflowIdRunsRidTraceLogResponse500 = {
|
|
845
|
+
data: InternalServerErrorResponse;
|
|
846
|
+
status: 500;
|
|
847
|
+
};
|
|
848
|
+
export type getWorkflowIdRunsRidTraceLogResponseSuccess = (getWorkflowIdRunsRidTraceLogResponse200) & {
|
|
849
|
+
headers: Headers;
|
|
850
|
+
};
|
|
851
|
+
export type getWorkflowIdRunsRidTraceLogResponseError = (getWorkflowIdRunsRidTraceLogResponse400 | getWorkflowIdRunsRidTraceLogResponse404 | getWorkflowIdRunsRidTraceLogResponse424 | getWorkflowIdRunsRidTraceLogResponse500) & {
|
|
852
|
+
headers: Headers;
|
|
853
|
+
};
|
|
854
|
+
export type getWorkflowIdRunsRidTraceLogResponse = (getWorkflowIdRunsRidTraceLogResponseSuccess | getWorkflowIdRunsRidTraceLogResponseError);
|
|
855
|
+
export declare const getGetWorkflowIdRunsRidTraceLogUrl: (id: string, rid: string) => string;
|
|
856
|
+
export declare const getWorkflowIdRunsRidTraceLog: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidTraceLogResponse>;
|
|
623
857
|
/**
|
|
624
858
|
* @summary Get a specific workflow catalog by ID
|
|
625
859
|
*/
|
|
@@ -694,6 +928,7 @@ export type getWorkflowRunsResponse = (getWorkflowRunsResponseSuccess | getWorkf
|
|
|
694
928
|
export declare const getGetWorkflowRunsUrl: (params?: GetWorkflowRunsParams) => string;
|
|
695
929
|
export declare const getWorkflowRuns: (params?: GetWorkflowRunsParams, options?: ApiRequestOptions) => Promise<getWorkflowRunsResponse>;
|
|
696
930
|
/**
|
|
931
|
+
* Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
|
|
697
932
|
* @summary Send feedback to a workflow
|
|
698
933
|
*/
|
|
699
934
|
export type postWorkflowIdFeedbackResponse200 = {
|
|
@@ -722,6 +957,7 @@ export type postWorkflowIdFeedbackResponse = (postWorkflowIdFeedbackResponseSucc
|
|
|
722
957
|
export declare const getPostWorkflowIdFeedbackUrl: (id: string) => string;
|
|
723
958
|
export declare const postWorkflowIdFeedback: (id: string, postWorkflowIdFeedbackBody: PostWorkflowIdFeedbackBody, options?: ApiRequestOptions) => Promise<postWorkflowIdFeedbackResponse>;
|
|
724
959
|
/**
|
|
960
|
+
* Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
|
|
725
961
|
* @summary Send a signal to an workflow
|
|
726
962
|
*/
|
|
727
963
|
export type postWorkflowIdSignalSignalResponse200 = {
|
|
@@ -750,6 +986,7 @@ export type postWorkflowIdSignalSignalResponse = (postWorkflowIdSignalSignalResp
|
|
|
750
986
|
export declare const getPostWorkflowIdSignalSignalUrl: (id: string, signal: string) => string;
|
|
751
987
|
export declare const postWorkflowIdSignalSignal: (id: string, signal: string, postWorkflowIdSignalSignalBody: PostWorkflowIdSignalSignalBody, options?: ApiRequestOptions) => Promise<postWorkflowIdSignalSignalResponse>;
|
|
752
988
|
/**
|
|
989
|
+
* Always targets the latest run; `runId` cannot be pinned for Temporal query operations.
|
|
753
990
|
* @summary Send a query to an workflow
|
|
754
991
|
*/
|
|
755
992
|
export type postWorkflowIdQueryQueryResponse200 = {
|
|
@@ -778,6 +1015,7 @@ export type postWorkflowIdQueryQueryResponse = (postWorkflowIdQueryQueryResponse
|
|
|
778
1015
|
export declare const getPostWorkflowIdQueryQueryUrl: (id: string, query: string) => string;
|
|
779
1016
|
export declare const postWorkflowIdQueryQuery: (id: string, query: string, postWorkflowIdQueryQueryBody: PostWorkflowIdQueryQueryBody, options?: ApiRequestOptions) => Promise<postWorkflowIdQueryQueryResponse>;
|
|
780
1017
|
/**
|
|
1018
|
+
* Always targets the latest run; `runId` cannot be pinned for Temporal update operations.
|
|
781
1019
|
* @summary Execute an update on an workflow
|
|
782
1020
|
*/
|
|
783
1021
|
export type postWorkflowIdUpdateUpdateResponse200 = {
|