@knowledge-stack/ksapi 1.139.1 → 1.140.1

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.
Files changed (101) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/README.md +25 -11
  3. package/dist/apis/AdminKbApi.d.ts +109 -0
  4. package/dist/apis/AdminKbApi.js +172 -0
  5. package/dist/apis/AdminWorkflowsApi.d.ts +252 -0
  6. package/dist/apis/AdminWorkflowsApi.js +337 -0
  7. package/dist/apis/index.d.ts +2 -0
  8. package/dist/apis/index.js +2 -0
  9. package/dist/esm/apis/AdminKbApi.d.ts +109 -0
  10. package/dist/esm/apis/AdminKbApi.js +135 -0
  11. package/dist/esm/apis/AdminWorkflowsApi.d.ts +252 -0
  12. package/dist/esm/apis/AdminWorkflowsApi.js +300 -0
  13. package/dist/esm/apis/index.d.ts +2 -0
  14. package/dist/esm/apis/index.js +2 -0
  15. package/dist/esm/models/CitedChunk.d.ts +6 -4
  16. package/dist/esm/models/DefinitionOutputStat.d.ts +65 -0
  17. package/dist/esm/models/DefinitionOutputStat.js +56 -0
  18. package/dist/esm/models/HourHistogramResponse.d.ts +53 -0
  19. package/dist/esm/models/HourHistogramResponse.js +54 -0
  20. package/dist/esm/models/KbMetric.d.ts +26 -0
  21. package/dist/esm/models/KbMetric.js +44 -0
  22. package/dist/esm/models/KbSummaryResponse.d.ts +152 -0
  23. package/dist/esm/models/KbSummaryResponse.js +109 -0
  24. package/dist/esm/models/KbTimeseriesResponse.d.ts +71 -0
  25. package/dist/esm/models/KbTimeseriesResponse.js +57 -0
  26. package/dist/esm/models/LabeledSeries.d.ts +54 -0
  27. package/dist/esm/models/LabeledSeries.js +47 -0
  28. package/dist/esm/models/LeaderboardEntry.d.ts +59 -0
  29. package/dist/esm/models/LeaderboardEntry.js +52 -0
  30. package/dist/esm/models/RunTimeseriesResponse.d.ts +61 -0
  31. package/dist/esm/models/RunTimeseriesResponse.js +52 -0
  32. package/dist/esm/models/TimeBucket.d.ts +27 -0
  33. package/dist/esm/models/TimeBucket.js +45 -0
  34. package/dist/esm/models/TimeseriesPoint.d.ts +53 -0
  35. package/dist/esm/models/TimeseriesPoint.js +48 -0
  36. package/dist/esm/models/WorkflowLeaderboardResponse.d.ts +54 -0
  37. package/dist/esm/models/WorkflowLeaderboardResponse.js +45 -0
  38. package/dist/esm/models/WorkflowOutputStatsResponse.d.ts +54 -0
  39. package/dist/esm/models/WorkflowOutputStatsResponse.js +47 -0
  40. package/dist/esm/models/index.d.ts +12 -0
  41. package/dist/esm/models/index.js +12 -0
  42. package/dist/models/CitedChunk.d.ts +6 -4
  43. package/dist/models/DefinitionOutputStat.d.ts +65 -0
  44. package/dist/models/DefinitionOutputStat.js +64 -0
  45. package/dist/models/HourHistogramResponse.d.ts +53 -0
  46. package/dist/models/HourHistogramResponse.js +62 -0
  47. package/dist/models/KbMetric.d.ts +26 -0
  48. package/dist/models/KbMetric.js +52 -0
  49. package/dist/models/KbSummaryResponse.d.ts +152 -0
  50. package/dist/models/KbSummaryResponse.js +117 -0
  51. package/dist/models/KbTimeseriesResponse.d.ts +71 -0
  52. package/dist/models/KbTimeseriesResponse.js +65 -0
  53. package/dist/models/LabeledSeries.d.ts +54 -0
  54. package/dist/models/LabeledSeries.js +55 -0
  55. package/dist/models/LeaderboardEntry.d.ts +59 -0
  56. package/dist/models/LeaderboardEntry.js +60 -0
  57. package/dist/models/RunTimeseriesResponse.d.ts +61 -0
  58. package/dist/models/RunTimeseriesResponse.js +60 -0
  59. package/dist/models/TimeBucket.d.ts +27 -0
  60. package/dist/models/TimeBucket.js +53 -0
  61. package/dist/models/TimeseriesPoint.d.ts +53 -0
  62. package/dist/models/TimeseriesPoint.js +56 -0
  63. package/dist/models/WorkflowLeaderboardResponse.d.ts +54 -0
  64. package/dist/models/WorkflowLeaderboardResponse.js +53 -0
  65. package/dist/models/WorkflowOutputStatsResponse.d.ts +54 -0
  66. package/dist/models/WorkflowOutputStatsResponse.js +55 -0
  67. package/dist/models/index.d.ts +12 -0
  68. package/dist/models/index.js +12 -0
  69. package/docs/AdminKbApi.md +163 -0
  70. package/docs/AdminWorkflowsApi.md +424 -0
  71. package/docs/CitedChunk.md +1 -1
  72. package/docs/DefinitionOutputStat.md +41 -0
  73. package/docs/HourHistogramResponse.md +37 -0
  74. package/docs/KbMetric.md +33 -0
  75. package/docs/KbSummaryResponse.md +67 -0
  76. package/docs/KbTimeseriesResponse.md +41 -0
  77. package/docs/LabeledSeries.md +37 -0
  78. package/docs/LeaderboardEntry.md +39 -0
  79. package/docs/RunTimeseriesResponse.md +39 -0
  80. package/docs/TimeBucket.md +33 -0
  81. package/docs/TimeseriesPoint.md +37 -0
  82. package/docs/WorkflowLeaderboardResponse.md +37 -0
  83. package/docs/WorkflowOutputStatsResponse.md +37 -0
  84. package/package.json +1 -1
  85. package/src/apis/AdminKbApi.ts +237 -0
  86. package/src/apis/AdminWorkflowsApi.ts +539 -0
  87. package/src/apis/index.ts +2 -0
  88. package/src/models/CitedChunk.ts +6 -4
  89. package/src/models/DefinitionOutputStat.ts +110 -0
  90. package/src/models/HourHistogramResponse.ts +97 -0
  91. package/src/models/KbMetric.ts +54 -0
  92. package/src/models/KbSummaryResponse.ts +235 -0
  93. package/src/models/KbTimeseriesResponse.ts +136 -0
  94. package/src/models/LabeledSeries.ts +99 -0
  95. package/src/models/LeaderboardEntry.ts +101 -0
  96. package/src/models/RunTimeseriesResponse.ts +117 -0
  97. package/src/models/TimeBucket.ts +55 -0
  98. package/src/models/TimeseriesPoint.ts +92 -0
  99. package/src/models/WorkflowLeaderboardResponse.ts +98 -0
  100. package/src/models/WorkflowOutputStatsResponse.ts +99 -0
  101. package/src/models/index.ts +12 -0
@@ -0,0 +1,252 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { HourHistogramResponse, RunTimeseriesResponse, TimeBucket, WorkflowLeaderboardResponse, WorkflowOutputStatsResponse, WorkflowRunSummaryResponse } from '../models/index';
14
+ export interface GetAdminWorkflowByHourRequest {
15
+ since?: Date | null;
16
+ until?: Date | null;
17
+ timezone?: string | null;
18
+ definitionId?: string | null;
19
+ }
20
+ export interface GetAdminWorkflowLeaderboardRequest {
21
+ since?: Date | null;
22
+ until?: Date | null;
23
+ limit?: number;
24
+ }
25
+ export interface GetAdminWorkflowOutputStatsRequest {
26
+ since?: Date | null;
27
+ until?: Date | null;
28
+ }
29
+ export interface GetAdminWorkflowSummaryRequest {
30
+ since?: Date | null;
31
+ until?: Date | null;
32
+ definitionId?: string | null;
33
+ }
34
+ export interface GetAdminWorkflowTimeseriesRequest {
35
+ since?: Date | null;
36
+ until?: Date | null;
37
+ bucket?: TimeBucket;
38
+ timezone?: string | null;
39
+ definitionId?: string | null;
40
+ }
41
+ /**
42
+ * AdminWorkflowsApi - interface
43
+ *
44
+ * @export
45
+ * @interface AdminWorkflowsApiInterface
46
+ */
47
+ export interface AdminWorkflowsApiInterface {
48
+ /**
49
+ * Creates request options for getAdminWorkflowByHour without sending the request
50
+ * @param {Date} [since] Window start.
51
+ * @param {Date} [until] Window end.
52
+ * @param {string} [timezone] IANA tz override; defaults to tenant setting.
53
+ * @param {string} [definitionId] Scope to one workflow.
54
+ * @throws {RequiredError}
55
+ * @memberof AdminWorkflowsApiInterface
56
+ */
57
+ getAdminWorkflowByHourRequestOpts(requestParameters: GetAdminWorkflowByHourRequest): Promise<runtime.RequestOpts>;
58
+ /**
59
+ * Runs per hour-of-day (0-23) in the resolved timezone.
60
+ * @summary Get Admin Workflow By Hour Handler
61
+ * @param {Date} [since] Window start.
62
+ * @param {Date} [until] Window end.
63
+ * @param {string} [timezone] IANA tz override; defaults to tenant setting.
64
+ * @param {string} [definitionId] Scope to one workflow.
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ * @memberof AdminWorkflowsApiInterface
68
+ */
69
+ getAdminWorkflowByHourRaw(requestParameters: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HourHistogramResponse>>;
70
+ /**
71
+ * Runs per hour-of-day (0-23) in the resolved timezone.
72
+ * Get Admin Workflow By Hour Handler
73
+ */
74
+ getAdminWorkflowByHour(requestParameters: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HourHistogramResponse>;
75
+ /**
76
+ * Creates request options for getAdminWorkflowLeaderboard without sending the request
77
+ * @param {Date} [since] Window start.
78
+ * @param {Date} [until] Window end.
79
+ * @param {number} [limit] Top-N per leaderboard.
80
+ * @throws {RequiredError}
81
+ * @memberof AdminWorkflowsApiInterface
82
+ */
83
+ getAdminWorkflowLeaderboardRequestOpts(requestParameters: GetAdminWorkflowLeaderboardRequest): Promise<runtime.RequestOpts>;
84
+ /**
85
+ * Top workflows and top run owners by run count.
86
+ * @summary Get Admin Workflow Leaderboard Handler
87
+ * @param {Date} [since] Window start.
88
+ * @param {Date} [until] Window end.
89
+ * @param {number} [limit] Top-N per leaderboard.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ * @memberof AdminWorkflowsApiInterface
93
+ */
94
+ getAdminWorkflowLeaderboardRaw(requestParameters: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowLeaderboardResponse>>;
95
+ /**
96
+ * Top workflows and top run owners by run count.
97
+ * Get Admin Workflow Leaderboard Handler
98
+ */
99
+ getAdminWorkflowLeaderboard(requestParameters: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowLeaderboardResponse>;
100
+ /**
101
+ * Creates request options for getAdminWorkflowOutputStats without sending the request
102
+ * @param {Date} [since] Window start.
103
+ * @param {Date} [until] Window end.
104
+ * @throws {RequiredError}
105
+ * @memberof AdminWorkflowsApiInterface
106
+ */
107
+ getAdminWorkflowOutputStatsRequestOpts(requestParameters: GetAdminWorkflowOutputStatsRequest): Promise<runtime.RequestOpts>;
108
+ /**
109
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
110
+ * @summary Get Admin Workflow Output Stats Handler
111
+ * @param {Date} [since] Window start.
112
+ * @param {Date} [until] Window end.
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ * @memberof AdminWorkflowsApiInterface
116
+ */
117
+ getAdminWorkflowOutputStatsRaw(requestParameters: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowOutputStatsResponse>>;
118
+ /**
119
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
120
+ * Get Admin Workflow Output Stats Handler
121
+ */
122
+ getAdminWorkflowOutputStats(requestParameters: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowOutputStatsResponse>;
123
+ /**
124
+ * Creates request options for getAdminWorkflowSummary without sending the request
125
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
126
+ * @param {Date} [until] Window end (inclusive).
127
+ * @param {string} [definitionId] Scope all numbers to one workflow.
128
+ * @throws {RequiredError}
129
+ * @memberof AdminWorkflowsApiInterface
130
+ */
131
+ getAdminWorkflowSummaryRequestOpts(requestParameters: GetAdminWorkflowSummaryRequest): Promise<runtime.RequestOpts>;
132
+ /**
133
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
134
+ * @summary Get Admin Workflow Summary Handler
135
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
136
+ * @param {Date} [until] Window end (inclusive).
137
+ * @param {string} [definitionId] Scope all numbers to one workflow.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ * @memberof AdminWorkflowsApiInterface
141
+ */
142
+ getAdminWorkflowSummaryRaw(requestParameters: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunSummaryResponse>>;
143
+ /**
144
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
145
+ * Get Admin Workflow Summary Handler
146
+ */
147
+ getAdminWorkflowSummary(requestParameters: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunSummaryResponse>;
148
+ /**
149
+ * Creates request options for getAdminWorkflowTimeseries without sending the request
150
+ * @param {Date} [since] Window start.
151
+ * @param {Date} [until] Window end.
152
+ * @param {TimeBucket} [bucket] Bucket size.
153
+ * @param {string} [timezone] IANA tz override; defaults to tenant setting.
154
+ * @param {string} [definitionId] Scope to one workflow.
155
+ * @throws {RequiredError}
156
+ * @memberof AdminWorkflowsApiInterface
157
+ */
158
+ getAdminWorkflowTimeseriesRequestOpts(requestParameters: GetAdminWorkflowTimeseriesRequest): Promise<runtime.RequestOpts>;
159
+ /**
160
+ * Run counts bucketed over time, in the resolved timezone.
161
+ * @summary Get Admin Workflow Timeseries Handler
162
+ * @param {Date} [since] Window start.
163
+ * @param {Date} [until] Window end.
164
+ * @param {TimeBucket} [bucket] Bucket size.
165
+ * @param {string} [timezone] IANA tz override; defaults to tenant setting.
166
+ * @param {string} [definitionId] Scope to one workflow.
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ * @memberof AdminWorkflowsApiInterface
170
+ */
171
+ getAdminWorkflowTimeseriesRaw(requestParameters: GetAdminWorkflowTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunTimeseriesResponse>>;
172
+ /**
173
+ * Run counts bucketed over time, in the resolved timezone.
174
+ * Get Admin Workflow Timeseries Handler
175
+ */
176
+ getAdminWorkflowTimeseries(requestParameters: GetAdminWorkflowTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunTimeseriesResponse>;
177
+ }
178
+ /**
179
+ *
180
+ */
181
+ export declare class AdminWorkflowsApi extends runtime.BaseAPI implements AdminWorkflowsApiInterface {
182
+ /**
183
+ * Creates request options for getAdminWorkflowByHour without sending the request
184
+ */
185
+ getAdminWorkflowByHourRequestOpts(requestParameters: GetAdminWorkflowByHourRequest): Promise<runtime.RequestOpts>;
186
+ /**
187
+ * Runs per hour-of-day (0-23) in the resolved timezone.
188
+ * Get Admin Workflow By Hour Handler
189
+ */
190
+ getAdminWorkflowByHourRaw(requestParameters: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HourHistogramResponse>>;
191
+ /**
192
+ * Runs per hour-of-day (0-23) in the resolved timezone.
193
+ * Get Admin Workflow By Hour Handler
194
+ */
195
+ getAdminWorkflowByHour(requestParameters?: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HourHistogramResponse>;
196
+ /**
197
+ * Creates request options for getAdminWorkflowLeaderboard without sending the request
198
+ */
199
+ getAdminWorkflowLeaderboardRequestOpts(requestParameters: GetAdminWorkflowLeaderboardRequest): Promise<runtime.RequestOpts>;
200
+ /**
201
+ * Top workflows and top run owners by run count.
202
+ * Get Admin Workflow Leaderboard Handler
203
+ */
204
+ getAdminWorkflowLeaderboardRaw(requestParameters: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowLeaderboardResponse>>;
205
+ /**
206
+ * Top workflows and top run owners by run count.
207
+ * Get Admin Workflow Leaderboard Handler
208
+ */
209
+ getAdminWorkflowLeaderboard(requestParameters?: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowLeaderboardResponse>;
210
+ /**
211
+ * Creates request options for getAdminWorkflowOutputStats without sending the request
212
+ */
213
+ getAdminWorkflowOutputStatsRequestOpts(requestParameters: GetAdminWorkflowOutputStatsRequest): Promise<runtime.RequestOpts>;
214
+ /**
215
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
216
+ * Get Admin Workflow Output Stats Handler
217
+ */
218
+ getAdminWorkflowOutputStatsRaw(requestParameters: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowOutputStatsResponse>>;
219
+ /**
220
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
221
+ * Get Admin Workflow Output Stats Handler
222
+ */
223
+ getAdminWorkflowOutputStats(requestParameters?: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowOutputStatsResponse>;
224
+ /**
225
+ * Creates request options for getAdminWorkflowSummary without sending the request
226
+ */
227
+ getAdminWorkflowSummaryRequestOpts(requestParameters: GetAdminWorkflowSummaryRequest): Promise<runtime.RequestOpts>;
228
+ /**
229
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
230
+ * Get Admin Workflow Summary Handler
231
+ */
232
+ getAdminWorkflowSummaryRaw(requestParameters: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunSummaryResponse>>;
233
+ /**
234
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
235
+ * Get Admin Workflow Summary Handler
236
+ */
237
+ getAdminWorkflowSummary(requestParameters?: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunSummaryResponse>;
238
+ /**
239
+ * Creates request options for getAdminWorkflowTimeseries without sending the request
240
+ */
241
+ getAdminWorkflowTimeseriesRequestOpts(requestParameters: GetAdminWorkflowTimeseriesRequest): Promise<runtime.RequestOpts>;
242
+ /**
243
+ * Run counts bucketed over time, in the resolved timezone.
244
+ * Get Admin Workflow Timeseries Handler
245
+ */
246
+ getAdminWorkflowTimeseriesRaw(requestParameters: GetAdminWorkflowTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunTimeseriesResponse>>;
247
+ /**
248
+ * Run counts bucketed over time, in the resolved timezone.
249
+ * Get Admin Workflow Timeseries Handler
250
+ */
251
+ getAdminWorkflowTimeseries(requestParameters?: GetAdminWorkflowTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunTimeseriesResponse>;
252
+ }
@@ -0,0 +1,337 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
16
+ if (k2 === undefined) k2 = k;
17
+ var desc = Object.getOwnPropertyDescriptor(m, k);
18
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
19
+ desc = { enumerable: true, get: function() { return m[k]; } };
20
+ }
21
+ Object.defineProperty(o, k2, desc);
22
+ }) : (function(o, m, k, k2) {
23
+ if (k2 === undefined) k2 = k;
24
+ o[k2] = m[k];
25
+ }));
26
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
27
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
28
+ }) : function(o, v) {
29
+ o["default"] = v;
30
+ });
31
+ var __importStar = (this && this.__importStar) || (function () {
32
+ var ownKeys = function(o) {
33
+ ownKeys = Object.getOwnPropertyNames || function (o) {
34
+ var ar = [];
35
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
36
+ return ar;
37
+ };
38
+ return ownKeys(o);
39
+ };
40
+ return function (mod) {
41
+ if (mod && mod.__esModule) return mod;
42
+ var result = {};
43
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
44
+ __setModuleDefault(result, mod);
45
+ return result;
46
+ };
47
+ })();
48
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
49
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
50
+ return new (P || (P = Promise))(function (resolve, reject) {
51
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
52
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
53
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
54
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
55
+ });
56
+ };
57
+ Object.defineProperty(exports, "__esModule", { value: true });
58
+ exports.AdminWorkflowsApi = void 0;
59
+ const runtime = __importStar(require("../runtime"));
60
+ const index_1 = require("../models/index");
61
+ /**
62
+ *
63
+ */
64
+ class AdminWorkflowsApi extends runtime.BaseAPI {
65
+ /**
66
+ * Creates request options for getAdminWorkflowByHour without sending the request
67
+ */
68
+ getAdminWorkflowByHourRequestOpts(requestParameters) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ const queryParameters = {};
71
+ if (requestParameters['since'] != null) {
72
+ queryParameters['since'] = requestParameters['since'].toISOString();
73
+ }
74
+ if (requestParameters['until'] != null) {
75
+ queryParameters['until'] = requestParameters['until'].toISOString();
76
+ }
77
+ if (requestParameters['timezone'] != null) {
78
+ queryParameters['timezone'] = requestParameters['timezone'];
79
+ }
80
+ if (requestParameters['definitionId'] != null) {
81
+ queryParameters['definition_id'] = requestParameters['definitionId'];
82
+ }
83
+ const headerParameters = {};
84
+ if (this.configuration && this.configuration.accessToken) {
85
+ const token = this.configuration.accessToken;
86
+ const tokenString = yield token("bearerAuth", []);
87
+ if (tokenString) {
88
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
89
+ }
90
+ }
91
+ let urlPath = `/v1/admin/workflows/by-hour`;
92
+ return {
93
+ path: urlPath,
94
+ method: 'GET',
95
+ headers: headerParameters,
96
+ query: queryParameters,
97
+ };
98
+ });
99
+ }
100
+ /**
101
+ * Runs per hour-of-day (0-23) in the resolved timezone.
102
+ * Get Admin Workflow By Hour Handler
103
+ */
104
+ getAdminWorkflowByHourRaw(requestParameters, initOverrides) {
105
+ return __awaiter(this, void 0, void 0, function* () {
106
+ const requestOptions = yield this.getAdminWorkflowByHourRequestOpts(requestParameters);
107
+ const response = yield this.request(requestOptions, initOverrides);
108
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HourHistogramResponseFromJSON)(jsonValue));
109
+ });
110
+ }
111
+ /**
112
+ * Runs per hour-of-day (0-23) in the resolved timezone.
113
+ * Get Admin Workflow By Hour Handler
114
+ */
115
+ getAdminWorkflowByHour() {
116
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
117
+ const response = yield this.getAdminWorkflowByHourRaw(requestParameters, initOverrides);
118
+ return yield response.value();
119
+ });
120
+ }
121
+ /**
122
+ * Creates request options for getAdminWorkflowLeaderboard without sending the request
123
+ */
124
+ getAdminWorkflowLeaderboardRequestOpts(requestParameters) {
125
+ return __awaiter(this, void 0, void 0, function* () {
126
+ const queryParameters = {};
127
+ if (requestParameters['since'] != null) {
128
+ queryParameters['since'] = requestParameters['since'].toISOString();
129
+ }
130
+ if (requestParameters['until'] != null) {
131
+ queryParameters['until'] = requestParameters['until'].toISOString();
132
+ }
133
+ if (requestParameters['limit'] != null) {
134
+ queryParameters['limit'] = requestParameters['limit'];
135
+ }
136
+ const headerParameters = {};
137
+ if (this.configuration && this.configuration.accessToken) {
138
+ const token = this.configuration.accessToken;
139
+ const tokenString = yield token("bearerAuth", []);
140
+ if (tokenString) {
141
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
142
+ }
143
+ }
144
+ let urlPath = `/v1/admin/workflows/leaderboard`;
145
+ return {
146
+ path: urlPath,
147
+ method: 'GET',
148
+ headers: headerParameters,
149
+ query: queryParameters,
150
+ };
151
+ });
152
+ }
153
+ /**
154
+ * Top workflows and top run owners by run count.
155
+ * Get Admin Workflow Leaderboard Handler
156
+ */
157
+ getAdminWorkflowLeaderboardRaw(requestParameters, initOverrides) {
158
+ return __awaiter(this, void 0, void 0, function* () {
159
+ const requestOptions = yield this.getAdminWorkflowLeaderboardRequestOpts(requestParameters);
160
+ const response = yield this.request(requestOptions, initOverrides);
161
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowLeaderboardResponseFromJSON)(jsonValue));
162
+ });
163
+ }
164
+ /**
165
+ * Top workflows and top run owners by run count.
166
+ * Get Admin Workflow Leaderboard Handler
167
+ */
168
+ getAdminWorkflowLeaderboard() {
169
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
170
+ const response = yield this.getAdminWorkflowLeaderboardRaw(requestParameters, initOverrides);
171
+ return yield response.value();
172
+ });
173
+ }
174
+ /**
175
+ * Creates request options for getAdminWorkflowOutputStats without sending the request
176
+ */
177
+ getAdminWorkflowOutputStatsRequestOpts(requestParameters) {
178
+ return __awaiter(this, void 0, void 0, function* () {
179
+ const queryParameters = {};
180
+ if (requestParameters['since'] != null) {
181
+ queryParameters['since'] = requestParameters['since'].toISOString();
182
+ }
183
+ if (requestParameters['until'] != null) {
184
+ queryParameters['until'] = requestParameters['until'].toISOString();
185
+ }
186
+ const headerParameters = {};
187
+ if (this.configuration && this.configuration.accessToken) {
188
+ const token = this.configuration.accessToken;
189
+ const tokenString = yield token("bearerAuth", []);
190
+ if (tokenString) {
191
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
192
+ }
193
+ }
194
+ let urlPath = `/v1/admin/workflows/output-stats`;
195
+ return {
196
+ path: urlPath,
197
+ method: 'GET',
198
+ headers: headerParameters,
199
+ query: queryParameters,
200
+ };
201
+ });
202
+ }
203
+ /**
204
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
205
+ * Get Admin Workflow Output Stats Handler
206
+ */
207
+ getAdminWorkflowOutputStatsRaw(requestParameters, initOverrides) {
208
+ return __awaiter(this, void 0, void 0, function* () {
209
+ const requestOptions = yield this.getAdminWorkflowOutputStatsRequestOpts(requestParameters);
210
+ const response = yield this.request(requestOptions, initOverrides);
211
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowOutputStatsResponseFromJSON)(jsonValue));
212
+ });
213
+ }
214
+ /**
215
+ * Average output DOCUMENTs generated per workflow definition (completed runs).
216
+ * Get Admin Workflow Output Stats Handler
217
+ */
218
+ getAdminWorkflowOutputStats() {
219
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
220
+ const response = yield this.getAdminWorkflowOutputStatsRaw(requestParameters, initOverrides);
221
+ return yield response.value();
222
+ });
223
+ }
224
+ /**
225
+ * Creates request options for getAdminWorkflowSummary without sending the request
226
+ */
227
+ getAdminWorkflowSummaryRequestOpts(requestParameters) {
228
+ return __awaiter(this, void 0, void 0, function* () {
229
+ const queryParameters = {};
230
+ if (requestParameters['since'] != null) {
231
+ queryParameters['since'] = requestParameters['since'].toISOString();
232
+ }
233
+ if (requestParameters['until'] != null) {
234
+ queryParameters['until'] = requestParameters['until'].toISOString();
235
+ }
236
+ if (requestParameters['definitionId'] != null) {
237
+ queryParameters['definition_id'] = requestParameters['definitionId'];
238
+ }
239
+ const headerParameters = {};
240
+ if (this.configuration && this.configuration.accessToken) {
241
+ const token = this.configuration.accessToken;
242
+ const tokenString = yield token("bearerAuth", []);
243
+ if (tokenString) {
244
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
245
+ }
246
+ }
247
+ let urlPath = `/v1/admin/workflows/summary`;
248
+ return {
249
+ path: urlPath,
250
+ method: 'GET',
251
+ headers: headerParameters,
252
+ query: queryParameters,
253
+ };
254
+ });
255
+ }
256
+ /**
257
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
258
+ * Get Admin Workflow Summary Handler
259
+ */
260
+ getAdminWorkflowSummaryRaw(requestParameters, initOverrides) {
261
+ return __awaiter(this, void 0, void 0, function* () {
262
+ const requestOptions = yield this.getAdminWorkflowSummaryRequestOpts(requestParameters);
263
+ const response = yield this.request(requestOptions, initOverrides);
264
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunSummaryResponseFromJSON)(jsonValue));
265
+ });
266
+ }
267
+ /**
268
+ * Tenant-wide run health: counts, failure rate, durations, approval backlog.
269
+ * Get Admin Workflow Summary Handler
270
+ */
271
+ getAdminWorkflowSummary() {
272
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
273
+ const response = yield this.getAdminWorkflowSummaryRaw(requestParameters, initOverrides);
274
+ return yield response.value();
275
+ });
276
+ }
277
+ /**
278
+ * Creates request options for getAdminWorkflowTimeseries without sending the request
279
+ */
280
+ getAdminWorkflowTimeseriesRequestOpts(requestParameters) {
281
+ return __awaiter(this, void 0, void 0, function* () {
282
+ const queryParameters = {};
283
+ if (requestParameters['since'] != null) {
284
+ queryParameters['since'] = requestParameters['since'].toISOString();
285
+ }
286
+ if (requestParameters['until'] != null) {
287
+ queryParameters['until'] = requestParameters['until'].toISOString();
288
+ }
289
+ if (requestParameters['bucket'] != null) {
290
+ queryParameters['bucket'] = requestParameters['bucket'];
291
+ }
292
+ if (requestParameters['timezone'] != null) {
293
+ queryParameters['timezone'] = requestParameters['timezone'];
294
+ }
295
+ if (requestParameters['definitionId'] != null) {
296
+ queryParameters['definition_id'] = requestParameters['definitionId'];
297
+ }
298
+ const headerParameters = {};
299
+ if (this.configuration && this.configuration.accessToken) {
300
+ const token = this.configuration.accessToken;
301
+ const tokenString = yield token("bearerAuth", []);
302
+ if (tokenString) {
303
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
304
+ }
305
+ }
306
+ let urlPath = `/v1/admin/workflows/timeseries`;
307
+ return {
308
+ path: urlPath,
309
+ method: 'GET',
310
+ headers: headerParameters,
311
+ query: queryParameters,
312
+ };
313
+ });
314
+ }
315
+ /**
316
+ * Run counts bucketed over time, in the resolved timezone.
317
+ * Get Admin Workflow Timeseries Handler
318
+ */
319
+ getAdminWorkflowTimeseriesRaw(requestParameters, initOverrides) {
320
+ return __awaiter(this, void 0, void 0, function* () {
321
+ const requestOptions = yield this.getAdminWorkflowTimeseriesRequestOpts(requestParameters);
322
+ const response = yield this.request(requestOptions, initOverrides);
323
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RunTimeseriesResponseFromJSON)(jsonValue));
324
+ });
325
+ }
326
+ /**
327
+ * Run counts bucketed over time, in the resolved timezone.
328
+ * Get Admin Workflow Timeseries Handler
329
+ */
330
+ getAdminWorkflowTimeseries() {
331
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
332
+ const response = yield this.getAdminWorkflowTimeseriesRaw(requestParameters, initOverrides);
333
+ return yield response.value();
334
+ });
335
+ }
336
+ }
337
+ exports.AdminWorkflowsApi = AdminWorkflowsApi;
@@ -1,3 +1,5 @@
1
+ export * from './AdminKbApi';
2
+ export * from './AdminWorkflowsApi';
1
3
  export * from './AgentApi';
2
4
  export * from './ApiConnectionsApi';
3
5
  export * from './ApiKeysApi';
@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./AdminKbApi"), exports);
20
+ __exportStar(require("./AdminWorkflowsApi"), exports);
19
21
  __exportStar(require("./AgentApi"), exports);
20
22
  __exportStar(require("./ApiConnectionsApi"), exports);
21
23
  __exportStar(require("./ApiKeysApi"), exports);