@outputai/cli 0.12.1-next.69255d7.0 → 0.12.1-next.77d68d4.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.
@@ -1,11 +1,11 @@
1
1
  /**
2
- * Generated by orval v8.9.0 🍺
2
+ * Generated by orval 🍺
3
3
  * Do not edit manually.
4
4
  * Output.ai API
5
5
  * API for managing and executing Output.ai workflows
6
6
  * OpenAPI spec version: 1.0.0
7
7
  */
8
- import { type ApiRequestOptions } from '../http_client.js';
8
+ import { customFetchInstance } from '../http_client.js';
9
9
  /**
10
10
  * API error body (WorkflowNotFoundError, UnsupportedWorkflowError, WorkflowExecutionTimedOutError, WorkflowNotCompletedError, CatalogNotAvailableError, or server error)
11
11
  */
@@ -66,18 +66,22 @@ export interface Workflow {
66
66
  /** Alternative names that resolve to this workflow */
67
67
  aliases?: string[];
68
68
  }
69
+ /**
70
+ * Available destinations for trace data
71
+ */
72
+ export type TraceInfoV1Destinations = {
73
+ /** Absolute path to local trace file, omitted if not saved locally */
74
+ local?: string;
75
+ /** Remote trace location (e.g., S3 URI), omitted if not saved remotely */
76
+ remote?: string;
77
+ };
69
78
  /**
70
79
  * Legacy trace information containing nested destinations
71
80
  * @nullable
72
81
  */
73
82
  export type TraceInfoV1 = {
74
83
  /** Available destinations for trace data */
75
- destinations?: {
76
- /** Absolute path to local trace file, omitted if not saved locally */
77
- local?: string;
78
- /** Remote trace location (e.g., S3 URI), omitted if not saved remotely */
79
- remote?: string;
80
- };
84
+ destinations?: TraceInfoV1Destinations;
81
85
  } | null;
82
86
  /**
83
87
  * Available destinations for trace data
@@ -233,6 +237,13 @@ export type SerializedWorkflowError = {
233
237
  message?: string;
234
238
  [key: string]: unknown;
235
239
  } | null;
240
+ /**
241
+ * Sanitized error cause chain (name/message per level, no stack)
242
+ * @nullable
243
+ */
244
+ export type WorkflowResultV1ResponseErrorDetailsCause = {
245
+ [key: string]: unknown;
246
+ } | null;
236
247
  /**
237
248
  * Structured failure details if the workflow failed, null otherwise
238
249
  * @nullable
@@ -262,10 +273,8 @@ export type WorkflowResultV1ResponseErrorDetails = {
262
273
  * Sanitized error cause chain (name/message per level, no stack)
263
274
  * @nullable
264
275
  */
265
- cause?: {
266
- [key: string]: unknown;
267
- } | null;
268
- } | null | null;
276
+ cause?: WorkflowResultV1ResponseErrorDetailsCause;
277
+ } | null;
269
278
  /**
270
279
  * Legacy wrapped workflow result
271
280
  * @deprecated
@@ -321,7 +330,7 @@ export interface WorkflowResultV2Response {
321
330
  /** Direct workflow output, null if no output is available */
322
331
  output: unknown | null;
323
332
  trace: TraceInfoV2 | null;
324
- error: (SerializedWorkflowError | null) | null;
333
+ error: SerializedWorkflowError | null;
325
334
  }
326
335
  export type WorkflowResultResponse = WorkflowResultV2Response | WorkflowResultV1Response;
327
336
  export interface WorkflowInputResponse {
@@ -450,7 +459,6 @@ export type GetWorkflowIdHistoryParams = {
450
459
  includePayloads?: boolean;
451
460
  /**
452
461
  * When set, long-poll for a new event once caught up to the end of history instead of returning immediately, bounding the block by this many milliseconds. Clamped to the server's configured maximum — a caller can shorten the wait but never exceed it. Omit for an immediate response; on timeout returns the same page's cursor unchanged with an empty events array so the caller can retry. Lets a poller keep the block roughly aligned with its own tick interval.
453
-
454
462
  * @minimum 1
455
463
  */
456
464
  longPollTimeoutMs?: number;
@@ -494,7 +502,6 @@ export type GetWorkflowIdRunsRidHistoryParams = {
494
502
  includePayloads?: boolean;
495
503
  /**
496
504
  * When set, long-poll for a new event once caught up to the end of history instead of returning immediately, bounding the block by this many milliseconds. Clamped to the server's configured maximum — a caller can shorten the wait but never exceed it. Omit for an immediate response; on timeout returns the same page's cursor unchanged with an empty events array so the caller can retry. Lets a poller keep the block roughly aligned with its own tick interval.
497
-
498
505
  * @minimum 1
499
506
  */
500
507
  longPollTimeoutMs?: number;
@@ -605,9 +612,6 @@ export type PostWorkflowIdUpdateUpdateBody = {
605
612
  /** The payload sent to the update operation */
606
613
  payload?: PostWorkflowIdUpdateUpdateBodyPayload;
607
614
  };
608
- /**
609
- * @summary Health check the API
610
- */
611
615
  export type getHealthResponse200 = {
612
616
  data: void;
613
617
  status: 200;
@@ -617,10 +621,10 @@ export type getHealthResponseSuccess = (getHealthResponse200) & {
617
621
  };
618
622
  export type getHealthResponse = (getHealthResponseSuccess);
619
623
  export declare const getGetHealthUrl: () => string;
620
- export declare const getHealth: (options?: ApiRequestOptions) => Promise<getHealthResponse>;
621
624
  /**
622
- * @summary Check if the API is ready to answer requests
625
+ * @summary Health check the API
623
626
  */
627
+ export declare const getHealth: (options?: Parameters<typeof customFetchInstance>[1]) => Promise<getHealthResponse>;
624
628
  export type getReadyResponse200 = {
625
629
  data: void;
626
630
  status: 200;
@@ -637,11 +641,10 @@ export type getReadyResponseError = (getReadyResponse503) & {
637
641
  };
638
642
  export type getReadyResponse = (getReadyResponseSuccess | getReadyResponseError);
639
643
  export declare const getGetReadyUrl: () => string;
640
- export declare const getReady: (options?: ApiRequestOptions) => Promise<getReadyResponse>;
641
644
  /**
642
- * Executes a workflow and waits for it to complete before returning the result
643
- * @summary Execute a workflow synchronously
645
+ * @summary Check if the API is ready to answer requests
644
646
  */
647
+ export declare const getReady: (options?: Parameters<typeof customFetchInstance>[1]) => Promise<getReadyResponse>;
645
648
  export type postWorkflowRunResponse200 = {
646
649
  data: WorkflowResultResponse;
647
650
  status: 200;
@@ -678,10 +681,11 @@ export type postWorkflowRunResponseError = (postWorkflowRunResponse400 | postWor
678
681
  };
679
682
  export type postWorkflowRunResponse = (postWorkflowRunResponseSuccess | postWorkflowRunResponseError);
680
683
  export declare const getPostWorkflowRunUrl: () => string;
681
- export declare const postWorkflowRun: (postWorkflowRunBody: PostWorkflowRunBody, options?: ApiRequestOptions) => Promise<postWorkflowRunResponse>;
682
684
  /**
683
- * @summary Start a workflow asynchronously
685
+ * Executes a workflow and waits for it to complete before returning the result
686
+ * @summary Execute a workflow synchronously
684
687
  */
688
+ export declare const postWorkflowRun: (postWorkflowRunBody: PostWorkflowRunBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowRunResponse>;
685
689
  export type postWorkflowStartResponse200 = {
686
690
  data: PostWorkflowStart200;
687
691
  status: 200;
@@ -714,11 +718,10 @@ export type postWorkflowStartResponseError = (postWorkflowStartResponse400 | pos
714
718
  };
715
719
  export type postWorkflowStartResponse = (postWorkflowStartResponseSuccess | postWorkflowStartResponseError);
716
720
  export declare const getPostWorkflowStartUrl: () => string;
717
- export declare const postWorkflowStart: (postWorkflowStartBody: PostWorkflowStartBody, options?: ApiRequestOptions) => Promise<postWorkflowStartResponse>;
718
721
  /**
719
- * Returns the status of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/status`.
720
- * @summary Get workflow execution status (latest run)
722
+ * @summary Start a workflow asynchronously
721
723
  */
724
+ export declare const postWorkflowStart: (postWorkflowStartBody: PostWorkflowStartBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowStartResponse>;
722
725
  export type getWorkflowIdStatusResponse200 = {
723
726
  data: WorkflowStatusResponse;
724
727
  status: 200;
@@ -739,10 +742,11 @@ export type getWorkflowIdStatusResponseError = (getWorkflowIdStatusResponse404 |
739
742
  };
740
743
  export type getWorkflowIdStatusResponse = (getWorkflowIdStatusResponseSuccess | getWorkflowIdStatusResponseError);
741
744
  export declare const getGetWorkflowIdStatusUrl: (id: string) => string;
742
- export declare const getWorkflowIdStatus: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdStatusResponse>;
743
745
  /**
744
- * @summary Get workflow execution status for a specific run
746
+ * Returns the status of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/status`.
747
+ * @summary Get workflow execution status (latest run)
745
748
  */
749
+ export declare const getWorkflowIdStatus: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdStatusResponse>;
746
750
  export type getWorkflowIdRunsRidStatusResponse200 = {
747
751
  data: WorkflowStatusResponse;
748
752
  status: 200;
@@ -767,10 +771,10 @@ export type getWorkflowIdRunsRidStatusResponseError = (getWorkflowIdRunsRidStatu
767
771
  };
768
772
  export type getWorkflowIdRunsRidStatusResponse = (getWorkflowIdRunsRidStatusResponseSuccess | getWorkflowIdRunsRidStatusResponseError);
769
773
  export declare const getGetWorkflowIdRunsRidStatusUrl: (id: string, rid: string) => string;
770
- export declare const getWorkflowIdRunsRidStatus: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidStatusResponse>;
771
774
  /**
772
- * @summary Stop a specific workflow run
775
+ * @summary Get workflow execution status for a specific run
773
776
  */
777
+ export declare const getWorkflowIdRunsRidStatus: (id: string, rid: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidStatusResponse>;
774
778
  export type patchWorkflowIdRunsRidStopResponse200 = {
775
779
  data: StopWorkflowResponse;
776
780
  status: 200;
@@ -799,12 +803,10 @@ export type patchWorkflowIdRunsRidStopResponseError = (patchWorkflowIdRunsRidSto
799
803
  };
800
804
  export type patchWorkflowIdRunsRidStopResponse = (patchWorkflowIdRunsRidStopResponseSuccess | patchWorkflowIdRunsRidStopResponseError);
801
805
  export declare const getPatchWorkflowIdRunsRidStopUrl: (id: string, rid: string) => string;
802
- export declare const patchWorkflowIdRunsRidStop: (id: string, rid: string, options?: ApiRequestOptions) => Promise<patchWorkflowIdRunsRidStopResponse>;
803
806
  /**
804
- * 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.
805
- * @deprecated
806
- * @summary [Deprecated] Stop the latest workflow run
807
+ * @summary Stop a specific workflow run
807
808
  */
809
+ export declare const patchWorkflowIdRunsRidStop: (id: string, rid: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<patchWorkflowIdRunsRidStopResponse>;
808
810
  export type patchWorkflowIdStopResponse200 = {
809
811
  data: StopWorkflowResponse;
810
812
  status: 200;
@@ -829,11 +831,12 @@ export type patchWorkflowIdStopResponseError = (patchWorkflowIdStopResponse404 |
829
831
  };
830
832
  export type patchWorkflowIdStopResponse = (patchWorkflowIdStopResponseSuccess | patchWorkflowIdStopResponseError);
831
833
  export declare const getPatchWorkflowIdStopUrl: (id: string) => string;
832
- export declare const patchWorkflowIdStop: (id: string, options?: ApiRequestOptions) => Promise<patchWorkflowIdStopResponse>;
833
834
  /**
834
- * Force terminates a workflow run. Unlike stop/cancel, terminate immediately stops the run without allowing cleanup.
835
- * @summary Terminate a specific workflow run (force stop)
835
+ * 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.
836
+ * @deprecated
837
+ * @summary [Deprecated] Stop the latest workflow run
836
838
  */
839
+ export declare const patchWorkflowIdStop: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<patchWorkflowIdStopResponse>;
837
840
  export type postWorkflowIdRunsRidTerminateResponse200 = {
838
841
  data: TerminateWorkflowResponse;
839
842
  status: 200;
@@ -862,12 +865,11 @@ export type postWorkflowIdRunsRidTerminateResponseError = (postWorkflowIdRunsRid
862
865
  };
863
866
  export type postWorkflowIdRunsRidTerminateResponse = (postWorkflowIdRunsRidTerminateResponseSuccess | postWorkflowIdRunsRidTerminateResponseError);
864
867
  export declare const getPostWorkflowIdRunsRidTerminateUrl: (id: string, rid: string) => string;
865
- export declare const postWorkflowIdRunsRidTerminate: (id: string, rid: string, postWorkflowIdRunsRidTerminateBody?: PostWorkflowIdRunsRidTerminateBody, options?: ApiRequestOptions) => Promise<postWorkflowIdRunsRidTerminateResponse>;
866
868
  /**
867
- * 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.
868
- * @deprecated
869
- * @summary [Deprecated] Terminate the latest workflow run
869
+ * Force terminates a workflow run. Unlike stop/cancel, terminate immediately stops the run without allowing cleanup.
870
+ * @summary Terminate a specific workflow run (force stop)
870
871
  */
872
+ export declare const postWorkflowIdRunsRidTerminate: (id: string, rid: string, postWorkflowIdRunsRidTerminateBody?: PostWorkflowIdRunsRidTerminateBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdRunsRidTerminateResponse>;
871
873
  export type postWorkflowIdTerminateResponse200 = {
872
874
  data: TerminateWorkflowResponse;
873
875
  status: 200;
@@ -896,11 +898,12 @@ export type postWorkflowIdTerminateResponseError = (postWorkflowIdTerminateRespo
896
898
  };
897
899
  export type postWorkflowIdTerminateResponse = (postWorkflowIdTerminateResponseSuccess | postWorkflowIdTerminateResponseError);
898
900
  export declare const getPostWorkflowIdTerminateUrl: (id: string) => string;
899
- export declare const postWorkflowIdTerminate: (id: string, postWorkflowIdTerminateBody?: PostWorkflowIdTerminateBody, options?: ApiRequestOptions) => Promise<postWorkflowIdTerminateResponse>;
900
901
  /**
901
- * 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.
902
- * @summary Reset a specific workflow run to re-run from after a completed step
902
+ * 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.
903
+ * @deprecated
904
+ * @summary [Deprecated] Terminate the latest workflow run
903
905
  */
906
+ export declare const postWorkflowIdTerminate: (id: string, postWorkflowIdTerminateBody?: PostWorkflowIdTerminateBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdTerminateResponse>;
904
907
  export type postWorkflowIdRunsRidResetResponse200 = {
905
908
  data: ResetWorkflowResponse;
906
909
  status: 200;
@@ -929,12 +932,11 @@ export type postWorkflowIdRunsRidResetResponseError = (postWorkflowIdRunsRidRese
929
932
  };
930
933
  export type postWorkflowIdRunsRidResetResponse = (postWorkflowIdRunsRidResetResponseSuccess | postWorkflowIdRunsRidResetResponseError);
931
934
  export declare const getPostWorkflowIdRunsRidResetUrl: (id: string, rid: string) => string;
932
- export declare const postWorkflowIdRunsRidReset: (id: string, rid: string, resetWorkflowRequest: ResetWorkflowRequest, options?: ApiRequestOptions) => Promise<postWorkflowIdRunsRidResetResponse>;
933
935
  /**
934
- * Resets the latest run. Deprecated; use `POST /workflow/{id}/runs/{rid}/reset` to target a specific run. Scheduled for removal after 2026-07-16.
935
- * @deprecated
936
- * @summary [Deprecated] Reset the latest workflow run
936
+ * 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.
937
+ * @summary Reset a specific workflow run to re-run from after a completed step
937
938
  */
939
+ export declare const postWorkflowIdRunsRidReset: (id: string, rid: string, resetWorkflowRequest: ResetWorkflowRequest, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdRunsRidResetResponse>;
938
940
  export type postWorkflowIdResetResponse200 = {
939
941
  data: ResetWorkflowResponse;
940
942
  status: 200;
@@ -963,11 +965,12 @@ export type postWorkflowIdResetResponseError = (postWorkflowIdResetResponse400 |
963
965
  };
964
966
  export type postWorkflowIdResetResponse = (postWorkflowIdResetResponseSuccess | postWorkflowIdResetResponseError);
965
967
  export declare const getPostWorkflowIdResetUrl: (id: string) => string;
966
- export declare const postWorkflowIdReset: (id: string, resetWorkflowRequest: ResetWorkflowRequest, options?: ApiRequestOptions) => Promise<postWorkflowIdResetResponse>;
967
968
  /**
968
- * Returns the result of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/result`.
969
- * @summary Return the result of a workflow (latest run)
969
+ * Resets the latest run. Deprecated; use `POST /workflow/{id}/runs/{rid}/reset` to target a specific run. Scheduled for removal after 2026-07-16.
970
+ * @deprecated
971
+ * @summary [Deprecated] Reset the latest workflow run
970
972
  */
973
+ export declare const postWorkflowIdReset: (id: string, resetWorkflowRequest: ResetWorkflowRequest, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdResetResponse>;
971
974
  export type getWorkflowIdResultResponse200 = {
972
975
  data: WorkflowResultResponse;
973
976
  status: 200;
@@ -992,10 +995,11 @@ export type getWorkflowIdResultResponseError = (getWorkflowIdResultResponse404 |
992
995
  };
993
996
  export type getWorkflowIdResultResponse = (getWorkflowIdResultResponseSuccess | getWorkflowIdResultResponseError);
994
997
  export declare const getGetWorkflowIdResultUrl: (id: string) => string;
995
- export declare const getWorkflowIdResult: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdResultResponse>;
996
998
  /**
997
- * @summary Return the result of a specific workflow run
999
+ * Returns the result of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/result`.
1000
+ * @summary Return the result of a workflow (latest run)
998
1001
  */
1002
+ export declare const getWorkflowIdResult: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdResultResponse>;
999
1003
  export type getWorkflowIdRunsRidResultResponse200 = {
1000
1004
  data: WorkflowResultResponse;
1001
1005
  status: 200;
@@ -1024,11 +1028,10 @@ export type getWorkflowIdRunsRidResultResponseError = (getWorkflowIdRunsRidResul
1024
1028
  };
1025
1029
  export type getWorkflowIdRunsRidResultResponse = (getWorkflowIdRunsRidResultResponseSuccess | getWorkflowIdRunsRidResultResponseError);
1026
1030
  export declare const getGetWorkflowIdRunsRidResultUrl: (id: string, rid: string) => string;
1027
- export declare const getWorkflowIdRunsRidResult: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidResultResponse>;
1028
1031
  /**
1029
- * Returns the original input passed to the latest run of the given workflow. Works for workflows in any state, including running. To pin a specific run, use `/workflow/{id}/runs/{rid}/input`.
1030
- * @summary Return the original input of a workflow (latest run)
1032
+ * @summary Return the result of a specific workflow run
1031
1033
  */
1034
+ export declare const getWorkflowIdRunsRidResult: (id: string, rid: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidResultResponse>;
1032
1035
  export type getWorkflowIdInputResponse200 = {
1033
1036
  data: WorkflowInputResponse;
1034
1037
  status: 200;
@@ -1049,10 +1052,11 @@ export type getWorkflowIdInputResponseError = (getWorkflowIdInputResponse404 | g
1049
1052
  };
1050
1053
  export type getWorkflowIdInputResponse = (getWorkflowIdInputResponseSuccess | getWorkflowIdInputResponseError);
1051
1054
  export declare const getGetWorkflowIdInputUrl: (id: string) => string;
1052
- export declare const getWorkflowIdInput: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdInputResponse>;
1053
1055
  /**
1054
- * @summary Return the original input of a specific workflow run
1056
+ * Returns the original input passed to the latest run of the given workflow. Works for workflows in any state, including running. To pin a specific run, use `/workflow/{id}/runs/{rid}/input`.
1057
+ * @summary Return the original input of a workflow (latest run)
1055
1058
  */
1059
+ export declare const getWorkflowIdInput: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdInputResponse>;
1056
1060
  export type getWorkflowIdRunsRidInputResponse200 = {
1057
1061
  data: WorkflowInputResponse;
1058
1062
  status: 200;
@@ -1077,11 +1081,10 @@ export type getWorkflowIdRunsRidInputResponseError = (getWorkflowIdRunsRidInputR
1077
1081
  };
1078
1082
  export type getWorkflowIdRunsRidInputResponse = (getWorkflowIdRunsRidInputResponseSuccess | getWorkflowIdRunsRidInputResponseError);
1079
1083
  export declare const getGetWorkflowIdRunsRidInputUrl: (id: string, rid: string) => string;
1080
- export declare const getWorkflowIdRunsRidInput: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidInputResponse>;
1081
1084
  /**
1082
- * 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`.
1083
- * @summary Get workflow trace log data (latest run)
1085
+ * @summary Return the original input of a specific workflow run
1084
1086
  */
1087
+ export declare const getWorkflowIdRunsRidInput: (id: string, rid: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidInputResponse>;
1085
1088
  export type getWorkflowIdTraceLogResponse200 = {
1086
1089
  data: TraceLogRemoteResponse | TraceLogLocalResponse;
1087
1090
  status: 200;
@@ -1106,11 +1109,11 @@ export type getWorkflowIdTraceLogResponseError = (getWorkflowIdTraceLogResponse4
1106
1109
  };
1107
1110
  export type getWorkflowIdTraceLogResponse = (getWorkflowIdTraceLogResponseSuccess | getWorkflowIdTraceLogResponseError);
1108
1111
  export declare const getGetWorkflowIdTraceLogUrl: (id: string) => string;
1109
- export declare const getWorkflowIdTraceLog: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowIdTraceLogResponse>;
1110
1112
  /**
1111
- * 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.
1112
- * @summary Get workflow trace log data for a specific run
1113
+ * 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`.
1114
+ * @summary Get workflow trace log data (latest run)
1113
1115
  */
1116
+ export declare const getWorkflowIdTraceLog: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdTraceLogResponse>;
1114
1117
  export type getWorkflowIdRunsRidTraceLogResponse200 = {
1115
1118
  data: TraceLogRemoteResponse | TraceLogLocalResponse;
1116
1119
  status: 200;
@@ -1139,11 +1142,11 @@ export type getWorkflowIdRunsRidTraceLogResponseError = (getWorkflowIdRunsRidTra
1139
1142
  };
1140
1143
  export type getWorkflowIdRunsRidTraceLogResponse = (getWorkflowIdRunsRidTraceLogResponseSuccess | getWorkflowIdRunsRidTraceLogResponseError);
1141
1144
  export declare const getGetWorkflowIdRunsRidTraceLogUrl: (id: string, rid: string) => string;
1142
- export declare const getWorkflowIdRunsRidTraceLog: (id: string, rid: string, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidTraceLogResponse>;
1143
1145
  /**
1144
- * Returns decoded Temporal history events with optional payload inclusion. First page includes workflow metadata; subsequent pages return events only.
1145
- * @summary Get paginated workflow execution history
1146
+ * 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.
1147
+ * @summary Get workflow trace log data for a specific run
1146
1148
  */
1149
+ export declare const getWorkflowIdRunsRidTraceLog: (id: string, rid: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidTraceLogResponse>;
1147
1150
  export type getWorkflowIdHistoryResponse200 = {
1148
1151
  data: GetWorkflowIdHistory200;
1149
1152
  status: 200;
@@ -1168,10 +1171,11 @@ export type getWorkflowIdHistoryResponseError = (getWorkflowIdHistoryResponse400
1168
1171
  };
1169
1172
  export type getWorkflowIdHistoryResponse = (getWorkflowIdHistoryResponseSuccess | getWorkflowIdHistoryResponseError);
1170
1173
  export declare const getGetWorkflowIdHistoryUrl: (id: string, params?: GetWorkflowIdHistoryParams) => string;
1171
- export declare const getWorkflowIdHistory: (id: string, params?: GetWorkflowIdHistoryParams, options?: ApiRequestOptions) => Promise<getWorkflowIdHistoryResponse>;
1172
1174
  /**
1173
- * @summary Get paginated workflow execution history for a specific run
1175
+ * Returns decoded Temporal history events with optional payload inclusion. First page includes workflow metadata; subsequent pages return events only.
1176
+ * @summary Get paginated workflow execution history
1174
1177
  */
1178
+ export declare const getWorkflowIdHistory: (id: string, params?: GetWorkflowIdHistoryParams, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdHistoryResponse>;
1175
1179
  export type getWorkflowIdRunsRidHistoryResponse200 = {
1176
1180
  data: GetWorkflowIdRunsRidHistory200;
1177
1181
  status: 200;
@@ -1196,12 +1200,10 @@ export type getWorkflowIdRunsRidHistoryResponseError = (getWorkflowIdRunsRidHist
1196
1200
  };
1197
1201
  export type getWorkflowIdRunsRidHistoryResponse = (getWorkflowIdRunsRidHistoryResponseSuccess | getWorkflowIdRunsRidHistoryResponseError);
1198
1202
  export declare const getGetWorkflowIdRunsRidHistoryUrl: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryParams) => string;
1199
- export declare const getWorkflowIdRunsRidHistory: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryParams, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidHistoryResponse>;
1200
1203
  /**
1201
- * Opens a persistent SSE connection that delivers Temporal workflow history events in real time. Emits named events: `workflow` (metadata, once), `history` (event batches), `done` (terminal state), `server_error` (post-flush errors). The `done` event carries `{ reason, newRunId? }` where `reason` is the terminal Temporal event type (`WORKFLOW_EXECUTION_COMPLETED`, `WORKFLOW_EXECUTION_FAILED`, `WORKFLOW_EXECUTION_TIMED_OUT`, `WORKFLOW_EXECUTION_CANCELED`, `WORKFLOW_EXECUTION_TERMINATED`, `WORKFLOW_EXECUTION_CONTINUED_AS_NEW`) and `newRunId` is present only when the terminal event chains a follow-on run. `server_error` carries `{ error, message, workflowId, runId }`. Errors before the stream opens are returned as JSON HTTP responses (400/404); once open, failures arrive as a `server_error` event. Supports reconnect via `Last-Event-ID` header or `lastEventId` query param.
1202
-
1203
- * @summary Stream workflow history events via Server-Sent Events
1204
+ * @summary Get paginated workflow execution history for a specific run
1204
1205
  */
1206
+ export declare const getWorkflowIdRunsRidHistory: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryParams, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidHistoryResponse>;
1205
1207
  export type getWorkflowIdHistoryStreamResponse200 = {
1206
1208
  data: string;
1207
1209
  status: 200;
@@ -1226,11 +1228,11 @@ export type getWorkflowIdHistoryStreamResponseError = (getWorkflowIdHistoryStrea
1226
1228
  };
1227
1229
  export type getWorkflowIdHistoryStreamResponse = (getWorkflowIdHistoryStreamResponseSuccess | getWorkflowIdHistoryStreamResponseError);
1228
1230
  export declare const getGetWorkflowIdHistoryStreamUrl: (id: string, params?: GetWorkflowIdHistoryStreamParams) => string;
1229
- export declare const getWorkflowIdHistoryStream: (id: string, params?: GetWorkflowIdHistoryStreamParams, options?: ApiRequestOptions) => Promise<getWorkflowIdHistoryStreamResponse>;
1230
1231
  /**
1231
- * Same as /workflow/{id}/history/stream but targets a specific run ID.
1232
- * @summary Stream pinned-run workflow history events via Server-Sent Events
1232
+ * Opens a persistent SSE connection that delivers Temporal workflow history events in real time. Emits named events: `workflow` (metadata, once), `history` (event batches), `done` (terminal state), `server_error` (post-flush errors). The `done` event carries `{ reason, newRunId? }` where `reason` is the terminal Temporal event type (`WORKFLOW_EXECUTION_COMPLETED`, `WORKFLOW_EXECUTION_FAILED`, `WORKFLOW_EXECUTION_TIMED_OUT`, `WORKFLOW_EXECUTION_CANCELED`, `WORKFLOW_EXECUTION_TERMINATED`, `WORKFLOW_EXECUTION_CONTINUED_AS_NEW`) and `newRunId` is present only when the terminal event chains a follow-on run. `server_error` carries `{ error, message, workflowId, runId }`. Errors before the stream opens are returned as JSON HTTP responses (400/404); once open, failures arrive as a `server_error` event. Supports reconnect via `Last-Event-ID` header or `lastEventId` query param.
1233
+ * @summary Stream workflow history events via Server-Sent Events
1233
1234
  */
1235
+ export declare const getWorkflowIdHistoryStream: (id: string, params?: GetWorkflowIdHistoryStreamParams, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdHistoryStreamResponse>;
1234
1236
  export type getWorkflowIdRunsRidHistoryStreamResponse200 = {
1235
1237
  data: string;
1236
1238
  status: 200;
@@ -1255,10 +1257,11 @@ export type getWorkflowIdRunsRidHistoryStreamResponseError = (getWorkflowIdRunsR
1255
1257
  };
1256
1258
  export type getWorkflowIdRunsRidHistoryStreamResponse = (getWorkflowIdRunsRidHistoryStreamResponseSuccess | getWorkflowIdRunsRidHistoryStreamResponseError);
1257
1259
  export declare const getGetWorkflowIdRunsRidHistoryStreamUrl: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryStreamParams) => string;
1258
- export declare const getWorkflowIdRunsRidHistoryStream: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryStreamParams, options?: ApiRequestOptions) => Promise<getWorkflowIdRunsRidHistoryStreamResponse>;
1259
1260
  /**
1260
- * @summary Get a specific workflow catalog by ID
1261
+ * Same as /workflow/{id}/history/stream but targets a specific run ID.
1262
+ * @summary Stream pinned-run workflow history events via Server-Sent Events
1261
1263
  */
1264
+ export declare const getWorkflowIdRunsRidHistoryStream: (id: string, rid: string, params?: GetWorkflowIdRunsRidHistoryStreamParams, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowIdRunsRidHistoryStreamResponse>;
1262
1265
  export type getWorkflowCatalogIdResponse200 = {
1263
1266
  data: GetWorkflowCatalogId200;
1264
1267
  status: 200;
@@ -1279,10 +1282,10 @@ export type getWorkflowCatalogIdResponseError = (getWorkflowCatalogIdResponse404
1279
1282
  };
1280
1283
  export type getWorkflowCatalogIdResponse = (getWorkflowCatalogIdResponseSuccess | getWorkflowCatalogIdResponseError);
1281
1284
  export declare const getGetWorkflowCatalogIdUrl: (id: string) => string;
1282
- export declare const getWorkflowCatalogId: (id: string, options?: ApiRequestOptions) => Promise<getWorkflowCatalogIdResponse>;
1283
1285
  /**
1284
- * @summary Get the default workflow catalog
1286
+ * @summary Get a specific workflow catalog by ID
1285
1287
  */
1288
+ export declare const getWorkflowCatalogId: (id: string, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowCatalogIdResponse>;
1286
1289
  export type getWorkflowCatalogResponse200 = {
1287
1290
  data: GetWorkflowCatalog200;
1288
1291
  status: 200;
@@ -1303,11 +1306,10 @@ export type getWorkflowCatalogResponseError = (getWorkflowCatalogResponse404 | g
1303
1306
  };
1304
1307
  export type getWorkflowCatalogResponse = (getWorkflowCatalogResponseSuccess | getWorkflowCatalogResponseError);
1305
1308
  export declare const getGetWorkflowCatalogUrl: () => string;
1306
- export declare const getWorkflowCatalog: (options?: ApiRequestOptions) => Promise<getWorkflowCatalogResponse>;
1307
1309
  /**
1308
- * Returns a list of workflow runs with optional filtering by workflow type
1309
- * @summary List workflow runs
1310
+ * @summary Get the default workflow catalog
1310
1311
  */
1312
+ export declare const getWorkflowCatalog: (options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowCatalogResponse>;
1311
1313
  export type getWorkflowRunsResponse200 = {
1312
1314
  data: WorkflowRunsResponse;
1313
1315
  status: 200;
@@ -1328,11 +1330,11 @@ export type getWorkflowRunsResponseError = (getWorkflowRunsResponse400 | getWork
1328
1330
  };
1329
1331
  export type getWorkflowRunsResponse = (getWorkflowRunsResponseSuccess | getWorkflowRunsResponseError);
1330
1332
  export declare const getGetWorkflowRunsUrl: (params?: GetWorkflowRunsParams) => string;
1331
- export declare const getWorkflowRuns: (params?: GetWorkflowRunsParams, options?: ApiRequestOptions) => Promise<getWorkflowRunsResponse>;
1332
1333
  /**
1333
- * Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
1334
- * @summary Send feedback to a workflow
1334
+ * Returns a list of workflow runs with optional filtering by workflow type
1335
+ * @summary List workflow runs
1335
1336
  */
1337
+ export declare const getWorkflowRuns: (params?: GetWorkflowRunsParams, options?: Parameters<typeof customFetchInstance>[1]) => Promise<getWorkflowRunsResponse>;
1336
1338
  export type postWorkflowIdFeedbackResponse200 = {
1337
1339
  data: void;
1338
1340
  status: 200;
@@ -1357,11 +1359,11 @@ export type postWorkflowIdFeedbackResponseError = (postWorkflowIdFeedbackRespons
1357
1359
  };
1358
1360
  export type postWorkflowIdFeedbackResponse = (postWorkflowIdFeedbackResponseSuccess | postWorkflowIdFeedbackResponseError);
1359
1361
  export declare const getPostWorkflowIdFeedbackUrl: (id: string) => string;
1360
- export declare const postWorkflowIdFeedback: (id: string, postWorkflowIdFeedbackBody: PostWorkflowIdFeedbackBody, options?: ApiRequestOptions) => Promise<postWorkflowIdFeedbackResponse>;
1361
1362
  /**
1362
1363
  * Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
1363
- * @summary Send a signal to an workflow
1364
+ * @summary Send feedback to a workflow
1364
1365
  */
1366
+ export declare const postWorkflowIdFeedback: (id: string, postWorkflowIdFeedbackBody: PostWorkflowIdFeedbackBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdFeedbackResponse>;
1365
1367
  export type postWorkflowIdSignalSignalResponse200 = {
1366
1368
  data: void;
1367
1369
  status: 200;
@@ -1386,11 +1388,11 @@ export type postWorkflowIdSignalSignalResponseError = (postWorkflowIdSignalSigna
1386
1388
  };
1387
1389
  export type postWorkflowIdSignalSignalResponse = (postWorkflowIdSignalSignalResponseSuccess | postWorkflowIdSignalSignalResponseError);
1388
1390
  export declare const getPostWorkflowIdSignalSignalUrl: (id: string, signal: string) => string;
1389
- export declare const postWorkflowIdSignalSignal: (id: string, signal: string, postWorkflowIdSignalSignalBody: PostWorkflowIdSignalSignalBody, options?: ApiRequestOptions) => Promise<postWorkflowIdSignalSignalResponse>;
1390
1391
  /**
1391
- * Always targets the latest run; `runId` cannot be pinned for Temporal query operations.
1392
- * @summary Send a query to an workflow
1392
+ * Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
1393
+ * @summary Send a signal to an workflow
1393
1394
  */
1395
+ export declare const postWorkflowIdSignalSignal: (id: string, signal: string, postWorkflowIdSignalSignalBody: PostWorkflowIdSignalSignalBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdSignalSignalResponse>;
1394
1396
  export type postWorkflowIdQueryQueryResponse200 = {
1395
1397
  data: void;
1396
1398
  status: 200;
@@ -1415,11 +1417,11 @@ export type postWorkflowIdQueryQueryResponseError = (postWorkflowIdQueryQueryRes
1415
1417
  };
1416
1418
  export type postWorkflowIdQueryQueryResponse = (postWorkflowIdQueryQueryResponseSuccess | postWorkflowIdQueryQueryResponseError);
1417
1419
  export declare const getPostWorkflowIdQueryQueryUrl: (id: string, query: string) => string;
1418
- export declare const postWorkflowIdQueryQuery: (id: string, query: string, postWorkflowIdQueryQueryBody: PostWorkflowIdQueryQueryBody, options?: ApiRequestOptions) => Promise<postWorkflowIdQueryQueryResponse>;
1419
1420
  /**
1420
- * Always targets the latest run; `runId` cannot be pinned for Temporal update operations.
1421
- * @summary Execute an update on an workflow
1421
+ * Always targets the latest run; `runId` cannot be pinned for Temporal query operations.
1422
+ * @summary Send a query to an workflow
1422
1423
  */
1424
+ export declare const postWorkflowIdQueryQuery: (id: string, query: string, postWorkflowIdQueryQueryBody: PostWorkflowIdQueryQueryBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdQueryQueryResponse>;
1423
1425
  export type postWorkflowIdUpdateUpdateResponse200 = {
1424
1426
  data: void;
1425
1427
  status: 200;
@@ -1444,10 +1446,11 @@ export type postWorkflowIdUpdateUpdateResponseError = (postWorkflowIdUpdateUpdat
1444
1446
  };
1445
1447
  export type postWorkflowIdUpdateUpdateResponse = (postWorkflowIdUpdateUpdateResponseSuccess | postWorkflowIdUpdateUpdateResponseError);
1446
1448
  export declare const getPostWorkflowIdUpdateUpdateUrl: (id: string, update: string) => string;
1447
- export declare const postWorkflowIdUpdateUpdate: (id: string, update: string, postWorkflowIdUpdateUpdateBody: PostWorkflowIdUpdateUpdateBody, options?: ApiRequestOptions) => Promise<postWorkflowIdUpdateUpdateResponse>;
1448
1449
  /**
1449
- * @summary A dummy post endpoint for test only
1450
+ * Always targets the latest run; `runId` cannot be pinned for Temporal update operations.
1451
+ * @summary Execute an update on an workflow
1450
1452
  */
1453
+ export declare const postWorkflowIdUpdateUpdate: (id: string, update: string, postWorkflowIdUpdateUpdateBody: PostWorkflowIdUpdateUpdateBody, options?: Parameters<typeof customFetchInstance>[1]) => Promise<postWorkflowIdUpdateUpdateResponse>;
1451
1454
  export type postHeartbeatResponse204 = {
1452
1455
  data: void;
1453
1456
  status: 204;
@@ -1457,4 +1460,7 @@ export type postHeartbeatResponseSuccess = (postHeartbeatResponse204) & {
1457
1460
  };
1458
1461
  export type postHeartbeatResponse = (postHeartbeatResponseSuccess);
1459
1462
  export declare const getPostHeartbeatUrl: () => string;
1460
- export declare const postHeartbeat: (options?: ApiRequestOptions) => Promise<postHeartbeatResponse>;
1463
+ /**
1464
+ * @summary A dummy post endpoint for test only
1465
+ */
1466
+ export declare const postHeartbeat: (options?: Parameters<typeof customFetchInstance>[1]) => Promise<postHeartbeatResponse>;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v8.9.0 🍺
2
+ * Generated by orval 🍺
3
3
  * Do not edit manually.
4
4
  * Output.ai API
5
5
  * API for managing and executing Output.ai workflows
@@ -49,6 +49,9 @@ export const WorkflowResultV2ResponseV = {
49
49
  export const getGetHealthUrl = () => {
50
50
  return `/health`;
51
51
  };
52
+ /**
53
+ * @summary Health check the API
54
+ */
52
55
  export const getHealth = async (options) => {
53
56
  return customFetchInstance(getGetHealthUrl(), {
54
57
  ...options,
@@ -58,6 +61,9 @@ export const getHealth = async (options) => {
58
61
  export const getGetReadyUrl = () => {
59
62
  return `/ready`;
60
63
  };
64
+ /**
65
+ * @summary Check if the API is ready to answer requests
66
+ */
61
67
  export const getReady = async (options) => {
62
68
  return customFetchInstance(getGetReadyUrl(), {
63
69
  ...options,
@@ -67,6 +73,10 @@ export const getReady = async (options) => {
67
73
  export const getPostWorkflowRunUrl = () => {
68
74
  return `/workflow/run`;
69
75
  };
76
+ /**
77
+ * Executes a workflow and waits for it to complete before returning the result
78
+ * @summary Execute a workflow synchronously
79
+ */
70
80
  export const postWorkflowRun = async (postWorkflowRunBody, options) => {
71
81
  return customFetchInstance(getPostWorkflowRunUrl(), {
72
82
  ...options,
@@ -78,6 +88,9 @@ export const postWorkflowRun = async (postWorkflowRunBody, options) => {
78
88
  export const getPostWorkflowStartUrl = () => {
79
89
  return `/workflow/start`;
80
90
  };
91
+ /**
92
+ * @summary Start a workflow asynchronously
93
+ */
81
94
  export const postWorkflowStart = async (postWorkflowStartBody, options) => {
82
95
  return customFetchInstance(getPostWorkflowStartUrl(), {
83
96
  ...options,
@@ -89,6 +102,10 @@ export const postWorkflowStart = async (postWorkflowStartBody, options) => {
89
102
  export const getGetWorkflowIdStatusUrl = (id) => {
90
103
  return `/workflow/${id}/status`;
91
104
  };
105
+ /**
106
+ * Returns the status of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/status`.
107
+ * @summary Get workflow execution status (latest run)
108
+ */
92
109
  export const getWorkflowIdStatus = async (id, options) => {
93
110
  return customFetchInstance(getGetWorkflowIdStatusUrl(id), {
94
111
  ...options,
@@ -98,6 +115,9 @@ export const getWorkflowIdStatus = async (id, options) => {
98
115
  export const getGetWorkflowIdRunsRidStatusUrl = (id, rid) => {
99
116
  return `/workflow/${id}/runs/${rid}/status`;
100
117
  };
118
+ /**
119
+ * @summary Get workflow execution status for a specific run
120
+ */
101
121
  export const getWorkflowIdRunsRidStatus = async (id, rid, options) => {
102
122
  return customFetchInstance(getGetWorkflowIdRunsRidStatusUrl(id, rid), {
103
123
  ...options,
@@ -107,6 +127,9 @@ export const getWorkflowIdRunsRidStatus = async (id, rid, options) => {
107
127
  export const getPatchWorkflowIdRunsRidStopUrl = (id, rid) => {
108
128
  return `/workflow/${id}/runs/${rid}/stop`;
109
129
  };
130
+ /**
131
+ * @summary Stop a specific workflow run
132
+ */
110
133
  export const patchWorkflowIdRunsRidStop = async (id, rid, options) => {
111
134
  return customFetchInstance(getPatchWorkflowIdRunsRidStopUrl(id, rid), {
112
135
  ...options,
@@ -116,6 +139,11 @@ export const patchWorkflowIdRunsRidStop = async (id, rid, options) => {
116
139
  export const getPatchWorkflowIdStopUrl = (id) => {
117
140
  return `/workflow/${id}/stop`;
118
141
  };
142
+ /**
143
+ * 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.
144
+ * @deprecated
145
+ * @summary [Deprecated] Stop the latest workflow run
146
+ */
119
147
  export const patchWorkflowIdStop = async (id, options) => {
120
148
  return customFetchInstance(getPatchWorkflowIdStopUrl(id), {
121
149
  ...options,
@@ -125,6 +153,10 @@ export const patchWorkflowIdStop = async (id, options) => {
125
153
  export const getPostWorkflowIdRunsRidTerminateUrl = (id, rid) => {
126
154
  return `/workflow/${id}/runs/${rid}/terminate`;
127
155
  };
156
+ /**
157
+ * Force terminates a workflow run. Unlike stop/cancel, terminate immediately stops the run without allowing cleanup.
158
+ * @summary Terminate a specific workflow run (force stop)
159
+ */
128
160
  export const postWorkflowIdRunsRidTerminate = async (id, rid, postWorkflowIdRunsRidTerminateBody, options) => {
129
161
  return customFetchInstance(getPostWorkflowIdRunsRidTerminateUrl(id, rid), {
130
162
  ...options,
@@ -136,6 +168,11 @@ export const postWorkflowIdRunsRidTerminate = async (id, rid, postWorkflowIdRuns
136
168
  export const getPostWorkflowIdTerminateUrl = (id) => {
137
169
  return `/workflow/${id}/terminate`;
138
170
  };
171
+ /**
172
+ * 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.
173
+ * @deprecated
174
+ * @summary [Deprecated] Terminate the latest workflow run
175
+ */
139
176
  export const postWorkflowIdTerminate = async (id, postWorkflowIdTerminateBody, options) => {
140
177
  return customFetchInstance(getPostWorkflowIdTerminateUrl(id), {
141
178
  ...options,
@@ -147,6 +184,10 @@ export const postWorkflowIdTerminate = async (id, postWorkflowIdTerminateBody, o
147
184
  export const getPostWorkflowIdRunsRidResetUrl = (id, rid) => {
148
185
  return `/workflow/${id}/runs/${rid}/reset`;
149
186
  };
187
+ /**
188
+ * 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.
189
+ * @summary Reset a specific workflow run to re-run from after a completed step
190
+ */
150
191
  export const postWorkflowIdRunsRidReset = async (id, rid, resetWorkflowRequest, options) => {
151
192
  return customFetchInstance(getPostWorkflowIdRunsRidResetUrl(id, rid), {
152
193
  ...options,
@@ -158,6 +199,11 @@ export const postWorkflowIdRunsRidReset = async (id, rid, resetWorkflowRequest,
158
199
  export const getPostWorkflowIdResetUrl = (id) => {
159
200
  return `/workflow/${id}/reset`;
160
201
  };
202
+ /**
203
+ * Resets the latest run. Deprecated; use `POST /workflow/{id}/runs/{rid}/reset` to target a specific run. Scheduled for removal after 2026-07-16.
204
+ * @deprecated
205
+ * @summary [Deprecated] Reset the latest workflow run
206
+ */
161
207
  export const postWorkflowIdReset = async (id, resetWorkflowRequest, options) => {
162
208
  return customFetchInstance(getPostWorkflowIdResetUrl(id), {
163
209
  ...options,
@@ -169,6 +215,10 @@ export const postWorkflowIdReset = async (id, resetWorkflowRequest, options) =>
169
215
  export const getGetWorkflowIdResultUrl = (id) => {
170
216
  return `/workflow/${id}/result`;
171
217
  };
218
+ /**
219
+ * Returns the result of the latest run for the given workflow. To pin a specific run, use `/workflow/{id}/runs/{rid}/result`.
220
+ * @summary Return the result of a workflow (latest run)
221
+ */
172
222
  export const getWorkflowIdResult = async (id, options) => {
173
223
  return customFetchInstance(getGetWorkflowIdResultUrl(id), {
174
224
  ...options,
@@ -178,6 +228,9 @@ export const getWorkflowIdResult = async (id, options) => {
178
228
  export const getGetWorkflowIdRunsRidResultUrl = (id, rid) => {
179
229
  return `/workflow/${id}/runs/${rid}/result`;
180
230
  };
231
+ /**
232
+ * @summary Return the result of a specific workflow run
233
+ */
181
234
  export const getWorkflowIdRunsRidResult = async (id, rid, options) => {
182
235
  return customFetchInstance(getGetWorkflowIdRunsRidResultUrl(id, rid), {
183
236
  ...options,
@@ -187,6 +240,10 @@ export const getWorkflowIdRunsRidResult = async (id, rid, options) => {
187
240
  export const getGetWorkflowIdInputUrl = (id) => {
188
241
  return `/workflow/${id}/input`;
189
242
  };
243
+ /**
244
+ * Returns the original input passed to the latest run of the given workflow. Works for workflows in any state, including running. To pin a specific run, use `/workflow/{id}/runs/{rid}/input`.
245
+ * @summary Return the original input of a workflow (latest run)
246
+ */
190
247
  export const getWorkflowIdInput = async (id, options) => {
191
248
  return customFetchInstance(getGetWorkflowIdInputUrl(id), {
192
249
  ...options,
@@ -196,6 +253,9 @@ export const getWorkflowIdInput = async (id, options) => {
196
253
  export const getGetWorkflowIdRunsRidInputUrl = (id, rid) => {
197
254
  return `/workflow/${id}/runs/${rid}/input`;
198
255
  };
256
+ /**
257
+ * @summary Return the original input of a specific workflow run
258
+ */
199
259
  export const getWorkflowIdRunsRidInput = async (id, rid, options) => {
200
260
  return customFetchInstance(getGetWorkflowIdRunsRidInputUrl(id, rid), {
201
261
  ...options,
@@ -205,6 +265,10 @@ export const getWorkflowIdRunsRidInput = async (id, rid, options) => {
205
265
  export const getGetWorkflowIdTraceLogUrl = (id) => {
206
266
  return `/workflow/${id}/trace-log`;
207
267
  };
268
+ /**
269
+ * 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`.
270
+ * @summary Get workflow trace log data (latest run)
271
+ */
208
272
  export const getWorkflowIdTraceLog = async (id, options) => {
209
273
  return customFetchInstance(getGetWorkflowIdTraceLogUrl(id), {
210
274
  ...options,
@@ -214,6 +278,10 @@ export const getWorkflowIdTraceLog = async (id, options) => {
214
278
  export const getGetWorkflowIdRunsRidTraceLogUrl = (id, rid) => {
215
279
  return `/workflow/${id}/runs/${rid}/trace-log`;
216
280
  };
281
+ /**
282
+ * 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.
283
+ * @summary Get workflow trace log data for a specific run
284
+ */
217
285
  export const getWorkflowIdRunsRidTraceLog = async (id, rid, options) => {
218
286
  return customFetchInstance(getGetWorkflowIdRunsRidTraceLogUrl(id, rid), {
219
287
  ...options,
@@ -224,12 +292,16 @@ export const getGetWorkflowIdHistoryUrl = (id, params) => {
224
292
  const normalizedParams = new URLSearchParams();
225
293
  Object.entries(params || {}).forEach(([key, value]) => {
226
294
  if (value !== undefined) {
227
- normalizedParams.append(key, value === null ? 'null' : value.toString());
295
+ normalizedParams.append(key, value === null ? 'null' : String(value));
228
296
  }
229
297
  });
230
298
  const stringifiedParams = normalizedParams.toString();
231
299
  return stringifiedParams.length > 0 ? `/workflow/${id}/history?${stringifiedParams}` : `/workflow/${id}/history`;
232
300
  };
301
+ /**
302
+ * Returns decoded Temporal history events with optional payload inclusion. First page includes workflow metadata; subsequent pages return events only.
303
+ * @summary Get paginated workflow execution history
304
+ */
233
305
  export const getWorkflowIdHistory = async (id, params, options) => {
234
306
  return customFetchInstance(getGetWorkflowIdHistoryUrl(id, params), {
235
307
  ...options,
@@ -240,12 +312,15 @@ export const getGetWorkflowIdRunsRidHistoryUrl = (id, rid, params) => {
240
312
  const normalizedParams = new URLSearchParams();
241
313
  Object.entries(params || {}).forEach(([key, value]) => {
242
314
  if (value !== undefined) {
243
- normalizedParams.append(key, value === null ? 'null' : value.toString());
315
+ normalizedParams.append(key, value === null ? 'null' : String(value));
244
316
  }
245
317
  });
246
318
  const stringifiedParams = normalizedParams.toString();
247
319
  return stringifiedParams.length > 0 ? `/workflow/${id}/runs/${rid}/history?${stringifiedParams}` : `/workflow/${id}/runs/${rid}/history`;
248
320
  };
321
+ /**
322
+ * @summary Get paginated workflow execution history for a specific run
323
+ */
249
324
  export const getWorkflowIdRunsRidHistory = async (id, rid, params, options) => {
250
325
  return customFetchInstance(getGetWorkflowIdRunsRidHistoryUrl(id, rid, params), {
251
326
  ...options,
@@ -256,12 +331,16 @@ export const getGetWorkflowIdHistoryStreamUrl = (id, params) => {
256
331
  const normalizedParams = new URLSearchParams();
257
332
  Object.entries(params || {}).forEach(([key, value]) => {
258
333
  if (value !== undefined) {
259
- normalizedParams.append(key, value === null ? 'null' : value.toString());
334
+ normalizedParams.append(key, value === null ? 'null' : String(value));
260
335
  }
261
336
  });
262
337
  const stringifiedParams = normalizedParams.toString();
263
338
  return stringifiedParams.length > 0 ? `/workflow/${id}/history/stream?${stringifiedParams}` : `/workflow/${id}/history/stream`;
264
339
  };
340
+ /**
341
+ * Opens a persistent SSE connection that delivers Temporal workflow history events in real time. Emits named events: `workflow` (metadata, once), `history` (event batches), `done` (terminal state), `server_error` (post-flush errors). The `done` event carries `{ reason, newRunId? }` where `reason` is the terminal Temporal event type (`WORKFLOW_EXECUTION_COMPLETED`, `WORKFLOW_EXECUTION_FAILED`, `WORKFLOW_EXECUTION_TIMED_OUT`, `WORKFLOW_EXECUTION_CANCELED`, `WORKFLOW_EXECUTION_TERMINATED`, `WORKFLOW_EXECUTION_CONTINUED_AS_NEW`) and `newRunId` is present only when the terminal event chains a follow-on run. `server_error` carries `{ error, message, workflowId, runId }`. Errors before the stream opens are returned as JSON HTTP responses (400/404); once open, failures arrive as a `server_error` event. Supports reconnect via `Last-Event-ID` header or `lastEventId` query param.
342
+ * @summary Stream workflow history events via Server-Sent Events
343
+ */
265
344
  export const getWorkflowIdHistoryStream = async (id, params, options) => {
266
345
  return customFetchInstance(getGetWorkflowIdHistoryStreamUrl(id, params), {
267
346
  ...options,
@@ -272,12 +351,16 @@ export const getGetWorkflowIdRunsRidHistoryStreamUrl = (id, rid, params) => {
272
351
  const normalizedParams = new URLSearchParams();
273
352
  Object.entries(params || {}).forEach(([key, value]) => {
274
353
  if (value !== undefined) {
275
- normalizedParams.append(key, value === null ? 'null' : value.toString());
354
+ normalizedParams.append(key, value === null ? 'null' : String(value));
276
355
  }
277
356
  });
278
357
  const stringifiedParams = normalizedParams.toString();
279
358
  return stringifiedParams.length > 0 ? `/workflow/${id}/runs/${rid}/history/stream?${stringifiedParams}` : `/workflow/${id}/runs/${rid}/history/stream`;
280
359
  };
360
+ /**
361
+ * Same as /workflow/{id}/history/stream but targets a specific run ID.
362
+ * @summary Stream pinned-run workflow history events via Server-Sent Events
363
+ */
281
364
  export const getWorkflowIdRunsRidHistoryStream = async (id, rid, params, options) => {
282
365
  return customFetchInstance(getGetWorkflowIdRunsRidHistoryStreamUrl(id, rid, params), {
283
366
  ...options,
@@ -287,6 +370,9 @@ export const getWorkflowIdRunsRidHistoryStream = async (id, rid, params, options
287
370
  export const getGetWorkflowCatalogIdUrl = (id) => {
288
371
  return `/workflow/catalog/${id}`;
289
372
  };
373
+ /**
374
+ * @summary Get a specific workflow catalog by ID
375
+ */
290
376
  export const getWorkflowCatalogId = async (id, options) => {
291
377
  return customFetchInstance(getGetWorkflowCatalogIdUrl(id), {
292
378
  ...options,
@@ -296,6 +382,9 @@ export const getWorkflowCatalogId = async (id, options) => {
296
382
  export const getGetWorkflowCatalogUrl = () => {
297
383
  return `/workflow/catalog`;
298
384
  };
385
+ /**
386
+ * @summary Get the default workflow catalog
387
+ */
299
388
  export const getWorkflowCatalog = async (options) => {
300
389
  return customFetchInstance(getGetWorkflowCatalogUrl(), {
301
390
  ...options,
@@ -306,12 +395,16 @@ export const getGetWorkflowRunsUrl = (params) => {
306
395
  const normalizedParams = new URLSearchParams();
307
396
  Object.entries(params || {}).forEach(([key, value]) => {
308
397
  if (value !== undefined) {
309
- normalizedParams.append(key, value === null ? 'null' : value.toString());
398
+ normalizedParams.append(key, value === null ? 'null' : String(value));
310
399
  }
311
400
  });
312
401
  const stringifiedParams = normalizedParams.toString();
313
402
  return stringifiedParams.length > 0 ? `/workflow/runs?${stringifiedParams}` : `/workflow/runs`;
314
403
  };
404
+ /**
405
+ * Returns a list of workflow runs with optional filtering by workflow type
406
+ * @summary List workflow runs
407
+ */
315
408
  export const getWorkflowRuns = async (params, options) => {
316
409
  return customFetchInstance(getGetWorkflowRunsUrl(params), {
317
410
  ...options,
@@ -321,6 +414,10 @@ export const getWorkflowRuns = async (params, options) => {
321
414
  export const getPostWorkflowIdFeedbackUrl = (id) => {
322
415
  return `/workflow/${id}/feedback`;
323
416
  };
417
+ /**
418
+ * Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
419
+ * @summary Send feedback to a workflow
420
+ */
324
421
  export const postWorkflowIdFeedback = async (id, postWorkflowIdFeedbackBody, options) => {
325
422
  return customFetchInstance(getPostWorkflowIdFeedbackUrl(id), {
326
423
  ...options,
@@ -332,6 +429,10 @@ export const postWorkflowIdFeedback = async (id, postWorkflowIdFeedbackBody, opt
332
429
  export const getPostWorkflowIdSignalSignalUrl = (id, signal) => {
333
430
  return `/workflow/${id}/signal/${signal}`;
334
431
  };
432
+ /**
433
+ * Always targets the latest run; `runId` cannot be pinned for Temporal signal operations.
434
+ * @summary Send a signal to an workflow
435
+ */
335
436
  export const postWorkflowIdSignalSignal = async (id, signal, postWorkflowIdSignalSignalBody, options) => {
336
437
  return customFetchInstance(getPostWorkflowIdSignalSignalUrl(id, signal), {
337
438
  ...options,
@@ -343,6 +444,10 @@ export const postWorkflowIdSignalSignal = async (id, signal, postWorkflowIdSigna
343
444
  export const getPostWorkflowIdQueryQueryUrl = (id, query) => {
344
445
  return `/workflow/${id}/query/${query}`;
345
446
  };
447
+ /**
448
+ * Always targets the latest run; `runId` cannot be pinned for Temporal query operations.
449
+ * @summary Send a query to an workflow
450
+ */
346
451
  export const postWorkflowIdQueryQuery = async (id, query, postWorkflowIdQueryQueryBody, options) => {
347
452
  return customFetchInstance(getPostWorkflowIdQueryQueryUrl(id, query), {
348
453
  ...options,
@@ -354,6 +459,10 @@ export const postWorkflowIdQueryQuery = async (id, query, postWorkflowIdQueryQue
354
459
  export const getPostWorkflowIdUpdateUpdateUrl = (id, update) => {
355
460
  return `/workflow/${id}/update/${update}`;
356
461
  };
462
+ /**
463
+ * Always targets the latest run; `runId` cannot be pinned for Temporal update operations.
464
+ * @summary Execute an update on an workflow
465
+ */
357
466
  export const postWorkflowIdUpdateUpdate = async (id, update, postWorkflowIdUpdateUpdateBody, options) => {
358
467
  return customFetchInstance(getPostWorkflowIdUpdateUpdateUrl(id, update), {
359
468
  ...options,
@@ -366,6 +475,9 @@ export const postWorkflowIdUpdateUpdate = async (id, update, postWorkflowIdUpdat
366
475
  export const getPostHeartbeatUrl = () => {
367
476
  return `/heartbeat`;
368
477
  };
478
+ /**
479
+ * @summary A dummy post endpoint for test only
480
+ */
369
481
  export const postHeartbeat = async (options) => {
370
482
  return customFetchInstance(getPostHeartbeatUrl(), {
371
483
  ...options,
@@ -80,7 +80,7 @@ services:
80
80
  condition: service_healthy
81
81
  worker:
82
82
  condition: service_healthy
83
- image: outputai/api:${OUTPUT_API_VERSION:-0.12.1-next.69255d7.0}
83
+ image: outputai/api:${OUTPUT_API_VERSION:-0.12.1-next.77d68d4.0}
84
84
  init: true
85
85
  networks:
86
86
  - main
@@ -1,3 +1,3 @@
1
1
  {
2
- "framework": "0.12.1-next.69255d7.0"
2
+ "framework": "0.12.1-next.77d68d4.0"
3
3
  }
@@ -1752,5 +1752,5 @@
1752
1752
  ]
1753
1753
  }
1754
1754
  },
1755
- "version": "0.12.1-next.69255d7.0"
1755
+ "version": "0.12.1-next.77d68d4.0"
1756
1756
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@outputai/cli",
3
- "version": "0.12.1-next.69255d7.0",
3
+ "version": "0.12.1-next.77d68d4.0",
4
4
  "description": "CLI for Output.ai workflow generation",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -30,15 +30,15 @@
30
30
  "handlebars": "4.7.9",
31
31
  "ink": "7.0.1",
32
32
  "ink-spinner": "5.0.0",
33
- "js-yaml": "4.3.1",
33
+ "js-yaml": "4.3.2",
34
34
  "json-schema-library": "11.4.0",
35
35
  "ky": "2.0.2",
36
36
  "react": "19.2.5",
37
37
  "semver": "7.7.4",
38
38
  "undici": "8.9.0",
39
- "@outputai/credentials": "0.12.1-next.69255d7.0",
40
- "@outputai/evals": "0.12.1-next.69255d7.0",
41
- "@outputai/llm": "0.12.1-next.69255d7.0"
39
+ "@outputai/credentials": "0.12.1-next.77d68d4.0",
40
+ "@outputai/llm": "0.12.1-next.77d68d4.0",
41
+ "@outputai/evals": "0.12.1-next.77d68d4.0"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@types/cli-progress": "3.11.6",
@@ -47,7 +47,7 @@
47
47
  "@types/react": "19.2.14",
48
48
  "@types/semver": "7.7.1",
49
49
  "oclif": "4.23.10",
50
- "orval": "8.9.0"
50
+ "orval": "8.24.0"
51
51
  },
52
52
  "license": "Apache-2.0",
53
53
  "publishConfig": {
@@ -1,11 +0,0 @@
1
- /**
2
- * Orval post-generation hook to fix ES module imports by adding .js extensions
3
- * and update RequestInit types to use our custom ApiRequestOptions.
4
- * This is necessary because the SDK uses "type": "module" in package.json,
5
- * which requires all relative imports to have explicit .js extensions.
6
- */
7
- export declare function fixEsmImports(outputPath: string): Promise<void>;
8
- /**
9
- * Run ESLint fix on generated files to ensure they follow project standards
10
- */
11
- export declare function runEslintFix(): Promise<void>;
@@ -1,46 +0,0 @@
1
- import { readFileSync, writeFileSync } from 'fs';
2
- import { execSync } from 'child_process';
3
- /**
4
- * Orval post-generation hook to fix ES module imports by adding .js extensions
5
- * and update RequestInit types to use our custom ApiRequestOptions.
6
- * This is necessary because the SDK uses "type": "module" in package.json,
7
- * which requires all relative imports to have explicit .js extensions.
8
- */
9
- export async function fixEsmImports(outputPath) {
10
- const originalContent = readFileSync(outputPath, 'utf8');
11
- // Apply all transformations in sequence
12
- const transformedContent = originalContent
13
- // Fix ESM imports
14
- .replace(/from '\.\.\/http_client'/g, 'from \'../http_client.js\'')
15
- // Import ApiRequestOptions type from http_client
16
- .replace(/import { customFetchInstance } from '\.\.\/http_client\.js';/, match => {
17
- if (!originalContent.includes('ApiRequestOptions')) {
18
- return 'import { customFetchInstance, type ApiRequestOptions } from \'../http_client.js\';';
19
- }
20
- return match;
21
- })
22
- // Replace RequestInit with ApiRequestOptions in function signatures
23
- .replace(/options\?: RequestInit/g, 'options?: ApiRequestOptions');
24
- writeFileSync(outputPath, transformedContent, 'utf8');
25
- console.log('✅ Fixed ESM imports and updated types in Orval generated file');
26
- }
27
- /**
28
- * Run ESLint fix on generated files to ensure they follow project standards
29
- */
30
- export async function runEslintFix() {
31
- try {
32
- execSync('npx eslint --fix src/api/generated/api.ts', {
33
- cwd: process.cwd(),
34
- stdio: 'pipe' // Suppress output
35
- });
36
- console.log('✅ Applied ESLint fixes to generated file');
37
- }
38
- catch (error) {
39
- if (error instanceof Error && 'status' in error && error.status === 1) {
40
- console.log('✅ Applied ESLint fixes to generated file (with warnings)');
41
- }
42
- else {
43
- console.warn('⚠️ ESLint fix encountered an issue:', error instanceof Error ? error.message : error);
44
- }
45
- }
46
- }