@knowledge-stack/ksapi 3.16.1 → 3.17.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.
Files changed (114) hide show
  1. package/.openapi-generator/FILES +26 -4
  2. package/README.md +23 -4
  3. package/dist/apis/MemoryApi.d.ts +5 -5
  4. package/dist/apis/MemoryApi.js +1 -1
  5. package/dist/apis/WorkflowMemoryApi.d.ts +17 -17
  6. package/dist/apis/WorkflowMemoryApi.js +4 -4
  7. package/dist/apis/WorkflowRepositoryApi.d.ts +419 -0
  8. package/dist/apis/WorkflowRepositoryApi.js +595 -0
  9. package/dist/apis/index.d.ts +1 -0
  10. package/dist/apis/index.js +1 -0
  11. package/dist/esm/apis/MemoryApi.d.ts +5 -5
  12. package/dist/esm/apis/MemoryApi.js +2 -2
  13. package/dist/esm/apis/WorkflowMemoryApi.d.ts +17 -17
  14. package/dist/esm/apis/WorkflowMemoryApi.js +5 -5
  15. package/dist/esm/apis/WorkflowRepositoryApi.d.ts +419 -0
  16. package/dist/esm/apis/WorkflowRepositoryApi.js +558 -0
  17. package/dist/esm/apis/index.d.ts +1 -0
  18. package/dist/esm/apis/index.js +1 -0
  19. package/dist/esm/models/ErrorResponse.d.ts +7 -0
  20. package/dist/esm/models/ErrorResponse.js +7 -0
  21. package/dist/esm/models/{MemoryChunkResponse.d.ts → MemoryEntryResponse.d.ts} +12 -12
  22. package/dist/esm/models/{MemoryChunkResponse.js → MemoryEntryResponse.js} +9 -9
  23. package/dist/esm/models/{PaginatedResponseMemoryChunkResponse.d.ts → PaginatedResponseMemoryEntryResponse.d.ts} +16 -16
  24. package/dist/esm/models/{PaginatedResponseMemoryChunkResponse.js → PaginatedResponseMemoryEntryResponse.js} +12 -12
  25. package/dist/esm/models/PaginatedResponseRepoVersionResponse.d.ts +66 -0
  26. package/dist/esm/models/PaginatedResponseRepoVersionResponse.js +70 -0
  27. package/dist/esm/models/RecordRepoSaveSkipRequest.d.ts +60 -0
  28. package/dist/esm/models/RecordRepoSaveSkipRequest.js +55 -0
  29. package/dist/esm/models/RepoBranchResponse.d.ts +126 -0
  30. package/dist/esm/models/RepoBranchResponse.js +95 -0
  31. package/dist/esm/models/RepoCommitSummary.d.ts +71 -0
  32. package/dist/esm/models/RepoCommitSummary.js +60 -0
  33. package/dist/esm/models/RepoSaveSkipReason.d.ts +36 -0
  34. package/dist/esm/models/RepoSaveSkipReason.js +54 -0
  35. package/dist/esm/models/RepoSnapshot.d.ts +59 -0
  36. package/dist/esm/models/RepoSnapshot.js +50 -0
  37. package/dist/esm/models/RepoTreeEntry.d.ts +59 -0
  38. package/dist/esm/models/RepoTreeEntry.js +52 -0
  39. package/dist/esm/models/RepoTreeResponse.d.ts +54 -0
  40. package/dist/esm/models/RepoTreeResponse.js +49 -0
  41. package/dist/esm/models/RepoVersionResponse.d.ts +95 -0
  42. package/dist/esm/models/RepoVersionResponse.js +74 -0
  43. package/dist/esm/models/WorkflowRepoResponse.d.ts +102 -0
  44. package/dist/esm/models/WorkflowRepoResponse.js +81 -0
  45. package/dist/esm/models/WorkflowRunSnapshot.d.ts +7 -0
  46. package/dist/esm/models/WorkflowRunSnapshot.js +3 -0
  47. package/dist/esm/models/index.d.ts +12 -2
  48. package/dist/esm/models/index.js +12 -2
  49. package/dist/models/ErrorResponse.d.ts +7 -0
  50. package/dist/models/ErrorResponse.js +7 -0
  51. package/dist/models/{MemoryChunkResponse.d.ts → MemoryEntryResponse.d.ts} +12 -12
  52. package/dist/models/{MemoryChunkResponse.js → MemoryEntryResponse.js} +15 -15
  53. package/dist/models/{PaginatedResponseMemoryChunkResponse.d.ts → PaginatedResponseMemoryEntryResponse.d.ts} +16 -16
  54. package/dist/models/{PaginatedResponseMemoryChunkResponse.js → PaginatedResponseMemoryEntryResponse.js} +18 -18
  55. package/dist/models/PaginatedResponseRepoVersionResponse.d.ts +66 -0
  56. package/dist/models/PaginatedResponseRepoVersionResponse.js +78 -0
  57. package/dist/models/RecordRepoSaveSkipRequest.d.ts +60 -0
  58. package/dist/models/RecordRepoSaveSkipRequest.js +63 -0
  59. package/dist/models/RepoBranchResponse.d.ts +126 -0
  60. package/dist/models/RepoBranchResponse.js +103 -0
  61. package/dist/models/RepoCommitSummary.d.ts +71 -0
  62. package/dist/models/RepoCommitSummary.js +68 -0
  63. package/dist/models/RepoSaveSkipReason.d.ts +36 -0
  64. package/dist/models/RepoSaveSkipReason.js +62 -0
  65. package/dist/models/RepoSnapshot.d.ts +59 -0
  66. package/dist/models/RepoSnapshot.js +58 -0
  67. package/dist/models/RepoTreeEntry.d.ts +59 -0
  68. package/dist/models/RepoTreeEntry.js +60 -0
  69. package/dist/models/RepoTreeResponse.d.ts +54 -0
  70. package/dist/models/RepoTreeResponse.js +57 -0
  71. package/dist/models/RepoVersionResponse.d.ts +95 -0
  72. package/dist/models/RepoVersionResponse.js +82 -0
  73. package/dist/models/WorkflowRepoResponse.d.ts +102 -0
  74. package/dist/models/WorkflowRepoResponse.js +89 -0
  75. package/dist/models/WorkflowRunSnapshot.d.ts +7 -0
  76. package/dist/models/WorkflowRunSnapshot.js +3 -0
  77. package/dist/models/index.d.ts +12 -2
  78. package/dist/models/index.js +12 -2
  79. package/docs/MemoryApi.md +2 -2
  80. package/docs/{MemoryChunkResponse.md → MemoryEntryResponse.md} +4 -4
  81. package/docs/{PaginatedResponseMemoryChunkResponse.md → PaginatedResponseMemoryEntryResponse.md} +5 -5
  82. package/docs/PaginatedResponseRepoVersionResponse.md +40 -0
  83. package/docs/RecordRepoSaveSkipRequest.md +38 -0
  84. package/docs/RepoBranchResponse.md +61 -0
  85. package/docs/RepoCommitSummary.md +42 -0
  86. package/docs/RepoSaveSkipReason.md +33 -0
  87. package/docs/RepoSnapshot.md +39 -0
  88. package/docs/RepoTreeEntry.md +38 -0
  89. package/docs/RepoTreeResponse.md +36 -0
  90. package/docs/RepoVersionResponse.md +51 -0
  91. package/docs/WorkflowMemoryApi.md +8 -8
  92. package/docs/WorkflowRepoResponse.md +53 -0
  93. package/docs/WorkflowRepositoryApi.md +745 -0
  94. package/docs/WorkflowRunSnapshot.md +2 -0
  95. package/package.json +1 -1
  96. package/src/apis/MemoryApi.ts +8 -8
  97. package/src/apis/WorkflowMemoryApi.ts +26 -26
  98. package/src/apis/WorkflowRepositoryApi.ts +1002 -0
  99. package/src/apis/index.ts +1 -0
  100. package/src/models/ErrorResponse.ts +7 -0
  101. package/src/models/{MemoryChunkResponse.ts → MemoryEntryResponse.ts} +14 -14
  102. package/src/models/{PaginatedResponseMemoryChunkResponse.ts → PaginatedResponseMemoryEntryResponse.ts} +25 -25
  103. package/src/models/PaginatedResponseRepoVersionResponse.ts +130 -0
  104. package/src/models/RecordRepoSaveSkipRequest.ts +113 -0
  105. package/src/models/RepoBranchResponse.ts +207 -0
  106. package/src/models/RepoCommitSummary.ts +119 -0
  107. package/src/models/RepoSaveSkipReason.ts +64 -0
  108. package/src/models/RepoSnapshot.ts +100 -0
  109. package/src/models/RepoTreeEntry.ts +101 -0
  110. package/src/models/RepoTreeResponse.ts +100 -0
  111. package/src/models/RepoVersionResponse.ts +154 -0
  112. package/src/models/WorkflowRepoResponse.ts +172 -0
  113. package/src/models/WorkflowRunSnapshot.ts +15 -0
  114. package/src/models/index.ts +12 -2
@@ -0,0 +1,95 @@
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
+ /**
13
+ * One saved version: a new main and the run that saved it.
14
+ * @export
15
+ * @interface RepoVersionResponse
16
+ */
17
+ export interface RepoVersionResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RepoVersionResponse
22
+ */
23
+ versionId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof RepoVersionResponse
28
+ */
29
+ headSha: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof RepoVersionResponse
34
+ */
35
+ previousHeadSha: string | null;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof RepoVersionResponse
40
+ */
41
+ commitsAdded: number;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof RepoVersionResponse
46
+ */
47
+ runId: string | null;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof RepoVersionResponse
52
+ */
53
+ savedByUserId: string;
54
+ /**
55
+ *
56
+ * @type {Date}
57
+ * @memberof RepoVersionResponse
58
+ */
59
+ savedAt: Date;
60
+ /**
61
+ *
62
+ * @type {string}
63
+ * @memberof RepoVersionResponse
64
+ */
65
+ instructionVersionId: string | null;
66
+ /**
67
+ * Retained run-branch version this publication integrated.
68
+ * @type {string}
69
+ * @memberof RepoVersionResponse
70
+ */
71
+ candidateVersionId?: string | null;
72
+ }
73
+ export declare const RepoVersionResponsePropertyValidationAttributesMap: {
74
+ [property: string]: {
75
+ maxLength?: number;
76
+ minLength?: number;
77
+ pattern?: string;
78
+ maximum?: number;
79
+ exclusiveMaximum?: boolean;
80
+ minimum?: number;
81
+ exclusiveMinimum?: boolean;
82
+ multipleOf?: number;
83
+ maxItems?: number;
84
+ minItems?: number;
85
+ uniqueItems?: boolean;
86
+ };
87
+ };
88
+ /**
89
+ * Check if a given object implements the RepoVersionResponse interface.
90
+ */
91
+ export declare function instanceOfRepoVersionResponse(value: object): value is RepoVersionResponse;
92
+ export declare function RepoVersionResponseFromJSON(json: any): RepoVersionResponse;
93
+ export declare function RepoVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoVersionResponse;
94
+ export declare function RepoVersionResponseToJSON(json: any): RepoVersionResponse;
95
+ export declare function RepoVersionResponseToJSONTyped(value?: RepoVersionResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,82 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.RepoVersionResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfRepoVersionResponse = instanceOfRepoVersionResponse;
18
+ exports.RepoVersionResponseFromJSON = RepoVersionResponseFromJSON;
19
+ exports.RepoVersionResponseFromJSONTyped = RepoVersionResponseFromJSONTyped;
20
+ exports.RepoVersionResponseToJSON = RepoVersionResponseToJSON;
21
+ exports.RepoVersionResponseToJSONTyped = RepoVersionResponseToJSONTyped;
22
+ exports.RepoVersionResponsePropertyValidationAttributesMap = {};
23
+ /**
24
+ * Check if a given object implements the RepoVersionResponse interface.
25
+ */
26
+ function instanceOfRepoVersionResponse(value) {
27
+ if (!('versionId' in value) || value['versionId'] === undefined)
28
+ return false;
29
+ if (!('headSha' in value) || value['headSha'] === undefined)
30
+ return false;
31
+ if (!('previousHeadSha' in value) || value['previousHeadSha'] === undefined)
32
+ return false;
33
+ if (!('commitsAdded' in value) || value['commitsAdded'] === undefined)
34
+ return false;
35
+ if (!('runId' in value) || value['runId'] === undefined)
36
+ return false;
37
+ if (!('savedByUserId' in value) || value['savedByUserId'] === undefined)
38
+ return false;
39
+ if (!('savedAt' in value) || value['savedAt'] === undefined)
40
+ return false;
41
+ if (!('instructionVersionId' in value) || value['instructionVersionId'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ function RepoVersionResponseFromJSON(json) {
46
+ return RepoVersionResponseFromJSONTyped(json, false);
47
+ }
48
+ function RepoVersionResponseFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'versionId': json['version_id'],
54
+ 'headSha': json['head_sha'],
55
+ 'previousHeadSha': json['previous_head_sha'],
56
+ 'commitsAdded': json['commits_added'],
57
+ 'runId': json['run_id'],
58
+ 'savedByUserId': json['saved_by_user_id'],
59
+ 'savedAt': (new Date(json['saved_at'])),
60
+ 'instructionVersionId': json['instruction_version_id'],
61
+ 'candidateVersionId': json['candidate_version_id'] == null ? undefined : json['candidate_version_id'],
62
+ };
63
+ }
64
+ function RepoVersionResponseToJSON(json) {
65
+ return RepoVersionResponseToJSONTyped(json, false);
66
+ }
67
+ function RepoVersionResponseToJSONTyped(value, ignoreDiscriminator = false) {
68
+ if (value == null) {
69
+ return value;
70
+ }
71
+ return {
72
+ 'version_id': value['versionId'],
73
+ 'head_sha': value['headSha'],
74
+ 'previous_head_sha': value['previousHeadSha'],
75
+ 'commits_added': value['commitsAdded'],
76
+ 'run_id': value['runId'],
77
+ 'saved_by_user_id': value['savedByUserId'],
78
+ 'saved_at': value['savedAt'].toISOString(),
79
+ 'instruction_version_id': value['instructionVersionId'],
80
+ 'candidate_version_id': value['candidateVersionId'],
81
+ };
82
+ }
@@ -0,0 +1,102 @@
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 type { RepoCommitSummary } from './RepoCommitSummary';
13
+ /**
14
+ * The workflow's repository at its current ``main``.
15
+ * @export
16
+ * @interface WorkflowRepoResponse
17
+ */
18
+ export interface WorkflowRepoResponse {
19
+ /**
20
+ * Directory name runs check the repository out under (`/work/<name>`); fixed by the first save.
21
+ * @type {string}
22
+ * @memberof WorkflowRepoResponse
23
+ */
24
+ name: string;
25
+ /**
26
+ *
27
+ * @type {boolean}
28
+ * @memberof WorkflowRepoResponse
29
+ */
30
+ _exists: boolean;
31
+ /**
32
+ * DocumentVersion holding the current main; null before any save.
33
+ * @type {string}
34
+ * @memberof WorkflowRepoResponse
35
+ */
36
+ versionId: string | null;
37
+ /**
38
+ *
39
+ * @type {RepoCommitSummary}
40
+ * @memberof WorkflowRepoResponse
41
+ */
42
+ head: RepoCommitSummary | null;
43
+ /**
44
+ *
45
+ * @type {number}
46
+ * @memberof WorkflowRepoResponse
47
+ */
48
+ fileCount: number;
49
+ /**
50
+ *
51
+ * @type {number}
52
+ * @memberof WorkflowRepoResponse
53
+ */
54
+ totalBytes: number;
55
+ /**
56
+ *
57
+ * @type {number}
58
+ * @memberof WorkflowRepoResponse
59
+ */
60
+ commitCount: number;
61
+ /**
62
+ *
63
+ * @type {Date}
64
+ * @memberof WorkflowRepoResponse
65
+ */
66
+ updatedAt: Date | null;
67
+ /**
68
+ * Whether the caller may save new versions (write on the workflow).
69
+ * @type {boolean}
70
+ * @memberof WorkflowRepoResponse
71
+ */
72
+ writableByMe: boolean;
73
+ /**
74
+ * Instruction version (DOCUMENT_VERSION path_part) the current main was saved against.
75
+ * @type {string}
76
+ * @memberof WorkflowRepoResponse
77
+ */
78
+ instructionVersionId: string | null;
79
+ }
80
+ export declare const WorkflowRepoResponsePropertyValidationAttributesMap: {
81
+ [property: string]: {
82
+ maxLength?: number;
83
+ minLength?: number;
84
+ pattern?: string;
85
+ maximum?: number;
86
+ exclusiveMaximum?: boolean;
87
+ minimum?: number;
88
+ exclusiveMinimum?: boolean;
89
+ multipleOf?: number;
90
+ maxItems?: number;
91
+ minItems?: number;
92
+ uniqueItems?: boolean;
93
+ };
94
+ };
95
+ /**
96
+ * Check if a given object implements the WorkflowRepoResponse interface.
97
+ */
98
+ export declare function instanceOfWorkflowRepoResponse(value: object): value is WorkflowRepoResponse;
99
+ export declare function WorkflowRepoResponseFromJSON(json: any): WorkflowRepoResponse;
100
+ export declare function WorkflowRepoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRepoResponse;
101
+ export declare function WorkflowRepoResponseToJSON(json: any): WorkflowRepoResponse;
102
+ export declare function WorkflowRepoResponseToJSONTyped(value?: WorkflowRepoResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,89 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.WorkflowRepoResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfWorkflowRepoResponse = instanceOfWorkflowRepoResponse;
18
+ exports.WorkflowRepoResponseFromJSON = WorkflowRepoResponseFromJSON;
19
+ exports.WorkflowRepoResponseFromJSONTyped = WorkflowRepoResponseFromJSONTyped;
20
+ exports.WorkflowRepoResponseToJSON = WorkflowRepoResponseToJSON;
21
+ exports.WorkflowRepoResponseToJSONTyped = WorkflowRepoResponseToJSONTyped;
22
+ const RepoCommitSummary_1 = require("./RepoCommitSummary");
23
+ exports.WorkflowRepoResponsePropertyValidationAttributesMap = {};
24
+ /**
25
+ * Check if a given object implements the WorkflowRepoResponse interface.
26
+ */
27
+ function instanceOfWorkflowRepoResponse(value) {
28
+ if (!('name' in value) || value['name'] === undefined)
29
+ return false;
30
+ if (!('_exists' in value) || value['_exists'] === undefined)
31
+ return false;
32
+ if (!('versionId' in value) || value['versionId'] === undefined)
33
+ return false;
34
+ if (!('head' in value) || value['head'] === undefined)
35
+ return false;
36
+ if (!('fileCount' in value) || value['fileCount'] === undefined)
37
+ return false;
38
+ if (!('totalBytes' in value) || value['totalBytes'] === undefined)
39
+ return false;
40
+ if (!('commitCount' in value) || value['commitCount'] === undefined)
41
+ return false;
42
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
43
+ return false;
44
+ if (!('writableByMe' in value) || value['writableByMe'] === undefined)
45
+ return false;
46
+ if (!('instructionVersionId' in value) || value['instructionVersionId'] === undefined)
47
+ return false;
48
+ return true;
49
+ }
50
+ function WorkflowRepoResponseFromJSON(json) {
51
+ return WorkflowRepoResponseFromJSONTyped(json, false);
52
+ }
53
+ function WorkflowRepoResponseFromJSONTyped(json, ignoreDiscriminator) {
54
+ if (json == null) {
55
+ return json;
56
+ }
57
+ return {
58
+ 'name': json['name'],
59
+ '_exists': json['exists'],
60
+ 'versionId': json['version_id'],
61
+ 'head': (0, RepoCommitSummary_1.RepoCommitSummaryFromJSON)(json['head']),
62
+ 'fileCount': json['file_count'],
63
+ 'totalBytes': json['total_bytes'],
64
+ 'commitCount': json['commit_count'],
65
+ 'updatedAt': (json['updated_at'] == null ? null : new Date(json['updated_at'])),
66
+ 'writableByMe': json['writable_by_me'],
67
+ 'instructionVersionId': json['instruction_version_id'],
68
+ };
69
+ }
70
+ function WorkflowRepoResponseToJSON(json) {
71
+ return WorkflowRepoResponseToJSONTyped(json, false);
72
+ }
73
+ function WorkflowRepoResponseToJSONTyped(value, ignoreDiscriminator = false) {
74
+ if (value == null) {
75
+ return value;
76
+ }
77
+ return {
78
+ 'name': value['name'],
79
+ 'exists': value['_exists'],
80
+ 'version_id': value['versionId'],
81
+ 'head': (0, RepoCommitSummary_1.RepoCommitSummaryToJSON)(value['head']),
82
+ 'file_count': value['fileCount'],
83
+ 'total_bytes': value['totalBytes'],
84
+ 'commit_count': value['commitCount'],
85
+ 'updated_at': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
86
+ 'writable_by_me': value['writableByMe'],
87
+ 'instruction_version_id': value['instructionVersionId'],
88
+ };
89
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { RepoSnapshot } from './RepoSnapshot';
12
13
  import type { InputSnapshot } from './InputSnapshot';
13
14
  import type { ExcludedCommonFile } from './ExcludedCommonFile';
14
15
  import type { InstructionSnapshot } from './InstructionSnapshot';
@@ -68,6 +69,12 @@ export interface WorkflowRunSnapshot {
68
69
  * @memberof WorkflowRunSnapshot
69
70
  */
70
71
  selectedSkillIds?: Array<string>;
72
+ /**
73
+ * The workflow repository's main when the run started; absent when the workflow had no repository.
74
+ * @type {RepoSnapshot}
75
+ * @memberof WorkflowRunSnapshot
76
+ */
77
+ repo?: RepoSnapshot | null;
71
78
  }
72
79
  export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
73
80
  [property: string]: {
@@ -19,6 +19,7 @@ exports.WorkflowRunSnapshotFromJSON = WorkflowRunSnapshotFromJSON;
19
19
  exports.WorkflowRunSnapshotFromJSONTyped = WorkflowRunSnapshotFromJSONTyped;
20
20
  exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
21
21
  exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
22
+ const RepoSnapshot_1 = require("./RepoSnapshot");
22
23
  const InputSnapshot_1 = require("./InputSnapshot");
23
24
  const ExcludedCommonFile_1 = require("./ExcludedCommonFile");
24
25
  const InstructionSnapshot_1 = require("./InstructionSnapshot");
@@ -56,6 +57,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
56
57
  'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFile_1.ExcludedCommonFileFromJSON)),
57
58
  'userMessage': json['user_message'] == null ? undefined : json['user_message'],
58
59
  'selectedSkillIds': json['selected_skill_ids'] == null ? undefined : json['selected_skill_ids'],
60
+ 'repo': json['repo'] == null ? undefined : (0, RepoSnapshot_1.RepoSnapshotFromJSON)(json['repo']),
59
61
  };
60
62
  }
61
63
  function WorkflowRunSnapshotToJSON(json) {
@@ -73,5 +75,6 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
73
75
  'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFile_1.ExcludedCommonFileToJSON)),
74
76
  'user_message': value['userMessage'],
75
77
  'selected_skill_ids': value['selectedSkillIds'],
78
+ 'repo': (0, RepoSnapshot_1.RepoSnapshotToJSON)(value['repo']),
76
79
  };
77
80
  }
@@ -200,7 +200,7 @@ export * from './LineageNodeResponse';
200
200
  export * from './LocationInner';
201
201
  export * from './MembershipResponse';
202
202
  export * from './MemoryBodyResponse';
203
- export * from './MemoryChunkResponse';
203
+ export * from './MemoryEntryResponse';
204
204
  export * from './MemoryKind';
205
205
  export * from './MemoryScope';
206
206
  export * from './MessageRole';
@@ -225,10 +225,11 @@ export * from './PaginatedResponseGroupPermissionResponse';
225
225
  export * from './PaginatedResponseGroupResponse';
226
226
  export * from './PaginatedResponseInviteResponse';
227
227
  export * from './PaginatedResponseMembershipResponse';
228
- export * from './PaginatedResponseMemoryChunkResponse';
228
+ export * from './PaginatedResponseMemoryEntryResponse';
229
229
  export * from './PaginatedResponsePathPartResponse';
230
230
  export * from './PaginatedResponsePendingMemoryChunkResponse';
231
231
  export * from './PaginatedResponsePermissionResponse';
232
+ export * from './PaginatedResponseRepoVersionResponse';
232
233
  export * from './PaginatedResponseSkillResponse';
233
234
  export * from './PaginatedResponseTagResponse';
234
235
  export * from './PaginatedResponseTenantResponse';
@@ -263,8 +264,16 @@ export * from './Polygon';
263
264
  export * from './PolygonReference';
264
265
  export * from './ProposeMemoryChunkRequest';
265
266
  export * from './ReasoningPart';
267
+ export * from './RecordRepoSaveSkipRequest';
266
268
  export * from './ReferenceType';
267
269
  export * from './ReorderPathPartRequest';
270
+ export * from './RepoBranchResponse';
271
+ export * from './RepoCommitSummary';
272
+ export * from './RepoSaveSkipReason';
273
+ export * from './RepoSnapshot';
274
+ export * from './RepoTreeEntry';
275
+ export * from './RepoTreeResponse';
276
+ export * from './RepoVersionResponse';
268
277
  export * from './RequestPhoneChangeRequest';
269
278
  export * from './ResolvedRef';
270
279
  export * from './ResolvedReferenceInput';
@@ -400,6 +409,7 @@ export * from './WorkflowDetailResponse';
400
409
  export * from './WorkflowExecutionState';
401
410
  export * from './WorkflowLeaderboardResponse';
402
411
  export * from './WorkflowOutputStatsResponse';
412
+ export * from './WorkflowRepoResponse';
403
413
  export * from './WorkflowRunAsset';
404
414
  export * from './WorkflowRunCallbackRequest';
405
415
  export * from './WorkflowRunOrder';
@@ -218,7 +218,7 @@ __exportStar(require("./LineageNodeResponse"), exports);
218
218
  __exportStar(require("./LocationInner"), exports);
219
219
  __exportStar(require("./MembershipResponse"), exports);
220
220
  __exportStar(require("./MemoryBodyResponse"), exports);
221
- __exportStar(require("./MemoryChunkResponse"), exports);
221
+ __exportStar(require("./MemoryEntryResponse"), exports);
222
222
  __exportStar(require("./MemoryKind"), exports);
223
223
  __exportStar(require("./MemoryScope"), exports);
224
224
  __exportStar(require("./MessageRole"), exports);
@@ -243,10 +243,11 @@ __exportStar(require("./PaginatedResponseGroupPermissionResponse"), exports);
243
243
  __exportStar(require("./PaginatedResponseGroupResponse"), exports);
244
244
  __exportStar(require("./PaginatedResponseInviteResponse"), exports);
245
245
  __exportStar(require("./PaginatedResponseMembershipResponse"), exports);
246
- __exportStar(require("./PaginatedResponseMemoryChunkResponse"), exports);
246
+ __exportStar(require("./PaginatedResponseMemoryEntryResponse"), exports);
247
247
  __exportStar(require("./PaginatedResponsePathPartResponse"), exports);
248
248
  __exportStar(require("./PaginatedResponsePendingMemoryChunkResponse"), exports);
249
249
  __exportStar(require("./PaginatedResponsePermissionResponse"), exports);
250
+ __exportStar(require("./PaginatedResponseRepoVersionResponse"), exports);
250
251
  __exportStar(require("./PaginatedResponseSkillResponse"), exports);
251
252
  __exportStar(require("./PaginatedResponseTagResponse"), exports);
252
253
  __exportStar(require("./PaginatedResponseTenantResponse"), exports);
@@ -281,8 +282,16 @@ __exportStar(require("./Polygon"), exports);
281
282
  __exportStar(require("./PolygonReference"), exports);
282
283
  __exportStar(require("./ProposeMemoryChunkRequest"), exports);
283
284
  __exportStar(require("./ReasoningPart"), exports);
285
+ __exportStar(require("./RecordRepoSaveSkipRequest"), exports);
284
286
  __exportStar(require("./ReferenceType"), exports);
285
287
  __exportStar(require("./ReorderPathPartRequest"), exports);
288
+ __exportStar(require("./RepoBranchResponse"), exports);
289
+ __exportStar(require("./RepoCommitSummary"), exports);
290
+ __exportStar(require("./RepoSaveSkipReason"), exports);
291
+ __exportStar(require("./RepoSnapshot"), exports);
292
+ __exportStar(require("./RepoTreeEntry"), exports);
293
+ __exportStar(require("./RepoTreeResponse"), exports);
294
+ __exportStar(require("./RepoVersionResponse"), exports);
286
295
  __exportStar(require("./RequestPhoneChangeRequest"), exports);
287
296
  __exportStar(require("./ResolvedRef"), exports);
288
297
  __exportStar(require("./ResolvedReferenceInput"), exports);
@@ -418,6 +427,7 @@ __exportStar(require("./WorkflowDetailResponse"), exports);
418
427
  __exportStar(require("./WorkflowExecutionState"), exports);
419
428
  __exportStar(require("./WorkflowLeaderboardResponse"), exports);
420
429
  __exportStar(require("./WorkflowOutputStatsResponse"), exports);
430
+ __exportStar(require("./WorkflowRepoResponse"), exports);
421
431
  __exportStar(require("./WorkflowRunAsset"), exports);
422
432
  __exportStar(require("./WorkflowRunCallbackRequest"), exports);
423
433
  __exportStar(require("./WorkflowRunOrder"), exports);
package/docs/MemoryApi.md CHANGED
@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:8000*
14
14
 
15
15
  ## approveMemoryProposal
16
16
 
17
- > MemoryChunkResponse approveMemoryProposal(chunkId)
17
+ > MemoryEntryResponse approveMemoryProposal(chunkId)
18
18
 
19
19
  Approve Memory Proposal Handler
20
20
 
@@ -63,7 +63,7 @@ example().catch(console.error);
63
63
 
64
64
  ### Return type
65
65
 
66
- [**MemoryChunkResponse**](MemoryChunkResponse.md)
66
+ [**MemoryEntryResponse**](MemoryEntryResponse.md)
67
67
 
68
68
  ### Authorization
69
69
 
@@ -1,5 +1,5 @@
1
1
 
2
- # MemoryChunkResponse
2
+ # MemoryEntryResponse
3
3
 
4
4
 
5
5
  ## Properties
@@ -13,14 +13,14 @@ Name | Type
13
13
  ## Example
14
14
 
15
15
  ```typescript
16
- import type { MemoryChunkResponse } from '@knowledge-stack/ksapi'
16
+ import type { MemoryEntryResponse } from '@knowledge-stack/ksapi'
17
17
 
18
18
  // TODO: Update the object below with actual values
19
19
  const example = {
20
20
  "chunkId": null,
21
21
  "kind": null,
22
22
  "body": null,
23
- } satisfies MemoryChunkResponse
23
+ } satisfies MemoryEntryResponse
24
24
 
25
25
  console.log(example)
26
26
 
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
29
29
  console.log(exampleJSON)
30
30
 
31
31
  // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as MemoryChunkResponse
32
+ const exampleParsed = JSON.parse(exampleJSON) as MemoryEntryResponse
33
33
  console.log(exampleParsed)
34
34
  ```
35
35
 
@@ -1,12 +1,12 @@
1
1
 
2
- # PaginatedResponseMemoryChunkResponse
2
+ # PaginatedResponseMemoryEntryResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `items` | [Array&lt;MemoryChunkResponse&gt;](MemoryChunkResponse.md)
9
+ `items` | [Array&lt;MemoryEntryResponse&gt;](MemoryEntryResponse.md)
10
10
  `total` | number
11
11
  `limit` | number
12
12
  `offset` | number
@@ -14,7 +14,7 @@ Name | Type
14
14
  ## Example
15
15
 
16
16
  ```typescript
17
- import type { PaginatedResponseMemoryChunkResponse } from '@knowledge-stack/ksapi'
17
+ import type { PaginatedResponseMemoryEntryResponse } from '@knowledge-stack/ksapi'
18
18
 
19
19
  // TODO: Update the object below with actual values
20
20
  const example = {
@@ -22,7 +22,7 @@ const example = {
22
22
  "total": null,
23
23
  "limit": null,
24
24
  "offset": null,
25
- } satisfies PaginatedResponseMemoryChunkResponse
25
+ } satisfies PaginatedResponseMemoryEntryResponse
26
26
 
27
27
  console.log(example)
28
28
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
31
31
  console.log(exampleJSON)
32
32
 
33
33
  // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseMemoryChunkResponse
34
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseMemoryEntryResponse
35
35
  console.log(exampleParsed)
36
36
  ```
37
37
 
@@ -0,0 +1,40 @@
1
+
2
+ # PaginatedResponseRepoVersionResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `items` | [Array&lt;RepoVersionResponse&gt;](RepoVersionResponse.md)
10
+ `total` | number
11
+ `limit` | number
12
+ `offset` | number
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { PaginatedResponseRepoVersionResponse } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "items": null,
22
+ "total": null,
23
+ "limit": null,
24
+ "offset": null,
25
+ } satisfies PaginatedResponseRepoVersionResponse
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseRepoVersionResponse
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+