@knowledge-stack/ksapi 1.135.1 → 1.136.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 (144) hide show
  1. package/.openapi-generator/FILES +28 -4
  2. package/README.md +29 -4
  3. package/dist/apis/FoldersApi.d.ts +9 -9
  4. package/dist/apis/FoldersApi.js +2 -2
  5. package/dist/apis/SkillsApi.d.ts +579 -0
  6. package/dist/apis/SkillsApi.js +786 -0
  7. package/dist/apis/WorkflowDefinitionsApi.d.ts +3 -0
  8. package/dist/apis/WorkflowDefinitionsApi.js +3 -0
  9. package/dist/apis/index.d.ts +1 -0
  10. package/dist/apis/index.js +1 -0
  11. package/dist/esm/apis/FoldersApi.d.ts +9 -9
  12. package/dist/esm/apis/FoldersApi.js +3 -3
  13. package/dist/esm/apis/SkillsApi.d.ts +579 -0
  14. package/dist/esm/apis/SkillsApi.js +749 -0
  15. package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +3 -0
  16. package/dist/esm/apis/WorkflowDefinitionsApi.js +3 -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/ActivateSkillVersionRequest.d.ts +47 -0
  20. package/dist/esm/models/ActivateSkillVersionRequest.js +42 -0
  21. package/dist/esm/models/CreateSkillRequest.d.ts +60 -0
  22. package/dist/esm/models/CreateSkillRequest.js +59 -0
  23. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  24. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +6 -0
  25. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.d.ts} +9 -6
  26. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.js} +11 -6
  27. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.d.ts} +16 -16
  28. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.js} +12 -12
  29. package/dist/esm/models/PaginatedResponseSkillResponse.d.ts +66 -0
  30. package/dist/esm/models/PaginatedResponseSkillResponse.js +70 -0
  31. package/dist/esm/models/PartType.d.ts +1 -0
  32. package/dist/esm/models/PartType.js +2 -1
  33. package/dist/esm/models/ReferenceType.d.ts +1 -0
  34. package/dist/esm/models/ReferenceType.js +1 -0
  35. package/dist/esm/models/SearchSkillsRequest.d.ts +59 -0
  36. package/dist/esm/models/SearchSkillsRequest.js +64 -0
  37. package/dist/esm/models/SearchSkillsResponse.d.ts +48 -0
  38. package/dist/esm/models/SearchSkillsResponse.js +43 -0
  39. package/dist/esm/models/SkillOrder.d.ts +26 -0
  40. package/dist/esm/models/SkillOrder.js +44 -0
  41. package/dist/esm/models/SkillResponse.d.ts +147 -0
  42. package/dist/esm/models/SkillResponse.js +101 -0
  43. package/dist/esm/models/SkillScriptFile.d.ts +53 -0
  44. package/dist/esm/models/SkillScriptFile.js +52 -0
  45. package/dist/esm/models/SkillSearchResult.d.ts +71 -0
  46. package/dist/esm/models/SkillSearchResult.js +60 -0
  47. package/dist/esm/models/SkillVersionResponse.d.ts +71 -0
  48. package/dist/esm/models/SkillVersionResponse.js +58 -0
  49. package/dist/esm/models/UpdateSkillRequest.d.ts +54 -0
  50. package/dist/esm/models/UpdateSkillRequest.js +50 -0
  51. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
  52. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +6 -0
  53. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +6 -0
  54. package/dist/esm/models/WorkflowDefinitionResponse.js +2 -0
  55. package/dist/esm/models/WorkflowRunSnapshot.d.ts +6 -0
  56. package/dist/esm/models/WorkflowRunSnapshot.js +2 -0
  57. package/dist/esm/models/index.d.ts +13 -2
  58. package/dist/esm/models/index.js +13 -2
  59. package/dist/models/ActivateSkillVersionRequest.d.ts +47 -0
  60. package/dist/models/ActivateSkillVersionRequest.js +50 -0
  61. package/dist/models/CreateSkillRequest.d.ts +60 -0
  62. package/dist/models/CreateSkillRequest.js +67 -0
  63. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  64. package/dist/models/CreateWorkflowDefinitionRequest.js +6 -0
  65. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.d.ts} +9 -6
  66. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.js} +15 -10
  67. package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.d.ts} +16 -16
  68. package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.js} +18 -18
  69. package/dist/models/PaginatedResponseSkillResponse.d.ts +66 -0
  70. package/dist/models/PaginatedResponseSkillResponse.js +78 -0
  71. package/dist/models/PartType.d.ts +1 -0
  72. package/dist/models/PartType.js +2 -1
  73. package/dist/models/ReferenceType.d.ts +1 -0
  74. package/dist/models/ReferenceType.js +1 -0
  75. package/dist/models/SearchSkillsRequest.d.ts +59 -0
  76. package/dist/models/SearchSkillsRequest.js +72 -0
  77. package/dist/models/SearchSkillsResponse.d.ts +48 -0
  78. package/dist/models/SearchSkillsResponse.js +51 -0
  79. package/dist/models/SkillOrder.d.ts +26 -0
  80. package/dist/models/SkillOrder.js +52 -0
  81. package/dist/models/SkillResponse.d.ts +147 -0
  82. package/dist/models/SkillResponse.js +109 -0
  83. package/dist/models/SkillScriptFile.d.ts +53 -0
  84. package/dist/models/SkillScriptFile.js +60 -0
  85. package/dist/models/SkillSearchResult.d.ts +71 -0
  86. package/dist/models/SkillSearchResult.js +68 -0
  87. package/dist/models/SkillVersionResponse.d.ts +71 -0
  88. package/dist/models/SkillVersionResponse.js +66 -0
  89. package/dist/models/UpdateSkillRequest.d.ts +54 -0
  90. package/dist/models/UpdateSkillRequest.js +58 -0
  91. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
  92. package/dist/models/UpdateWorkflowDefinitionRequest.js +6 -0
  93. package/dist/models/WorkflowDefinitionResponse.d.ts +6 -0
  94. package/dist/models/WorkflowDefinitionResponse.js +2 -0
  95. package/dist/models/WorkflowRunSnapshot.d.ts +6 -0
  96. package/dist/models/WorkflowRunSnapshot.js +2 -0
  97. package/dist/models/index.d.ts +13 -2
  98. package/dist/models/index.js +13 -2
  99. package/docs/ActivateSkillVersionRequest.md +35 -0
  100. package/docs/ChunksApi.md +1 -1
  101. package/docs/CreateSkillRequest.md +39 -0
  102. package/docs/CreateWorkflowDefinitionRequest.md +2 -0
  103. package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md} +12 -4
  104. package/docs/FoldersApi.md +4 -4
  105. package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md} +5 -5
  106. package/docs/PaginatedResponseSkillResponse.md +40 -0
  107. package/docs/SearchSkillsRequest.md +39 -0
  108. package/docs/SearchSkillsResponse.md +34 -0
  109. package/docs/SkillOrder.md +33 -0
  110. package/docs/SkillResponse.md +65 -0
  111. package/docs/SkillScriptFile.md +37 -0
  112. package/docs/SkillSearchResult.md +43 -0
  113. package/docs/SkillVersionResponse.md +43 -0
  114. package/docs/SkillsApi.md +1093 -0
  115. package/docs/UpdateSkillRequest.md +37 -0
  116. package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
  117. package/docs/WorkflowDefinitionResponse.md +2 -0
  118. package/docs/WorkflowDefinitionsApi.md +4 -1
  119. package/docs/WorkflowRunSnapshot.md +2 -0
  120. package/package.json +1 -1
  121. package/src/apis/FoldersApi.ts +13 -13
  122. package/src/apis/SkillsApi.ts +1321 -0
  123. package/src/apis/WorkflowDefinitionsApi.ts +7 -0
  124. package/src/apis/index.ts +1 -0
  125. package/src/models/ActivateSkillVersionRequest.ts +82 -0
  126. package/src/models/CreateSkillRequest.ts +115 -0
  127. package/src/models/CreateWorkflowDefinitionRequest.ts +12 -0
  128. package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.ts} +19 -8
  129. package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.ts} +25 -25
  130. package/src/models/PaginatedResponseSkillResponse.ts +130 -0
  131. package/src/models/PartType.ts +2 -1
  132. package/src/models/ReferenceType.ts +1 -0
  133. package/src/models/SearchSkillsRequest.ts +114 -0
  134. package/src/models/SearchSkillsResponse.ts +90 -0
  135. package/src/models/SkillOrder.ts +54 -0
  136. package/src/models/SkillResponse.ts +244 -0
  137. package/src/models/SkillScriptFile.ts +95 -0
  138. package/src/models/SkillSearchResult.ts +119 -0
  139. package/src/models/SkillVersionResponse.ts +118 -0
  140. package/src/models/UpdateSkillRequest.ts +102 -0
  141. package/src/models/UpdateWorkflowDefinitionRequest.ts +12 -0
  142. package/src/models/WorkflowDefinitionResponse.ts +8 -0
  143. package/src/models/WorkflowRunSnapshot.ts +8 -0
  144. package/src/models/index.ts +13 -2
@@ -0,0 +1,66 @@
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.SkillVersionResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfSkillVersionResponse = instanceOfSkillVersionResponse;
18
+ exports.SkillVersionResponseFromJSON = SkillVersionResponseFromJSON;
19
+ exports.SkillVersionResponseFromJSONTyped = SkillVersionResponseFromJSONTyped;
20
+ exports.SkillVersionResponseToJSON = SkillVersionResponseToJSON;
21
+ exports.SkillVersionResponseToJSONTyped = SkillVersionResponseToJSONTyped;
22
+ exports.SkillVersionResponsePropertyValidationAttributesMap = {};
23
+ /**
24
+ * Check if a given object implements the SkillVersionResponse interface.
25
+ */
26
+ function instanceOfSkillVersionResponse(value) {
27
+ if (!('versionId' in value) || value['versionId'] === undefined)
28
+ return false;
29
+ if (!('version' in value) || value['version'] === undefined)
30
+ return false;
31
+ if (!('isActive' in value) || value['isActive'] === undefined)
32
+ return false;
33
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ function SkillVersionResponseFromJSON(json) {
38
+ return SkillVersionResponseFromJSONTyped(json, false);
39
+ }
40
+ function SkillVersionResponseFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'versionId': json['version_id'],
46
+ 'version': json['version'],
47
+ 'contentSha256': json['content_sha256'] == null ? undefined : json['content_sha256'],
48
+ 'isActive': json['is_active'],
49
+ 'createdAt': (new Date(json['created_at'])),
50
+ };
51
+ }
52
+ function SkillVersionResponseToJSON(json) {
53
+ return SkillVersionResponseToJSONTyped(json, false);
54
+ }
55
+ function SkillVersionResponseToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ 'version_id': value['versionId'],
61
+ 'version': value['version'],
62
+ 'content_sha256': value['contentSha256'],
63
+ 'is_active': value['isActive'],
64
+ 'created_at': value['createdAt'].toISOString(),
65
+ };
66
+ }
@@ -0,0 +1,54 @@
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 { SkillScriptFile } from './SkillScriptFile';
13
+ /**
14
+ * Edit working-copy files in place (does NOT cut a version).
15
+ * @export
16
+ * @interface UpdateSkillRequest
17
+ */
18
+ export interface UpdateSkillRequest {
19
+ /**
20
+ * Replacement SKILL.md, written to the working copy in place; null leaves it unchanged. Publish a version to snapshot; the active version is unchanged until then.
21
+ * @type {string}
22
+ * @memberof UpdateSkillRequest
23
+ */
24
+ skillMd?: string | null;
25
+ /**
26
+ * Replace the working-copy scripts set (add/overwrite/remove to match); null leaves scripts unchanged, [] removes them all.
27
+ * @type {Array<SkillScriptFile>}
28
+ * @memberof UpdateSkillRequest
29
+ */
30
+ scripts?: Array<SkillScriptFile> | null;
31
+ }
32
+ export declare const UpdateSkillRequestPropertyValidationAttributesMap: {
33
+ [property: string]: {
34
+ maxLength?: number;
35
+ minLength?: number;
36
+ pattern?: string;
37
+ maximum?: number;
38
+ exclusiveMaximum?: boolean;
39
+ minimum?: number;
40
+ exclusiveMinimum?: boolean;
41
+ multipleOf?: number;
42
+ maxItems?: number;
43
+ minItems?: number;
44
+ uniqueItems?: boolean;
45
+ };
46
+ };
47
+ /**
48
+ * Check if a given object implements the UpdateSkillRequest interface.
49
+ */
50
+ export declare function instanceOfUpdateSkillRequest(value: object): value is UpdateSkillRequest;
51
+ export declare function UpdateSkillRequestFromJSON(json: any): UpdateSkillRequest;
52
+ export declare function UpdateSkillRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSkillRequest;
53
+ export declare function UpdateSkillRequestToJSON(json: any): UpdateSkillRequest;
54
+ export declare function UpdateSkillRequestToJSONTyped(value?: UpdateSkillRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
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.UpdateSkillRequestPropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfUpdateSkillRequest = instanceOfUpdateSkillRequest;
18
+ exports.UpdateSkillRequestFromJSON = UpdateSkillRequestFromJSON;
19
+ exports.UpdateSkillRequestFromJSONTyped = UpdateSkillRequestFromJSONTyped;
20
+ exports.UpdateSkillRequestToJSON = UpdateSkillRequestToJSON;
21
+ exports.UpdateSkillRequestToJSONTyped = UpdateSkillRequestToJSONTyped;
22
+ const SkillScriptFile_1 = require("./SkillScriptFile");
23
+ exports.UpdateSkillRequestPropertyValidationAttributesMap = {
24
+ scripts: {
25
+ maxItems: 50,
26
+ uniqueItems: false,
27
+ },
28
+ };
29
+ /**
30
+ * Check if a given object implements the UpdateSkillRequest interface.
31
+ */
32
+ function instanceOfUpdateSkillRequest(value) {
33
+ return true;
34
+ }
35
+ function UpdateSkillRequestFromJSON(json) {
36
+ return UpdateSkillRequestFromJSONTyped(json, false);
37
+ }
38
+ function UpdateSkillRequestFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
44
+ 'scripts': json['scripts'] == null ? undefined : (json['scripts'].map(SkillScriptFile_1.SkillScriptFileFromJSON)),
45
+ };
46
+ }
47
+ function UpdateSkillRequestToJSON(json) {
48
+ return UpdateSkillRequestToJSONTyped(json, false);
49
+ }
50
+ function UpdateSkillRequestToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ 'skill_md': value['skillMd'],
56
+ 'scripts': value['scripts'] == null ? undefined : (value['scripts'].map(SkillScriptFile_1.SkillScriptFileToJSON)),
57
+ };
58
+ }
@@ -57,6 +57,12 @@ export interface UpdateWorkflowDefinitionRequest {
57
57
  * @memberof UpdateWorkflowDefinitionRequest
58
58
  */
59
59
  approvalRequired: boolean;
60
+ /**
61
+ * Skill PDO ids force-loaded into every run by default. Retain-on-None PUT semantics: null (or omit) keeps the stored list, [] clears, a list replaces. Each must be a readable SKILL.
62
+ * @type {Array<string>}
63
+ * @memberof UpdateWorkflowDefinitionRequest
64
+ */
65
+ selectedSkillIds?: Array<string> | null;
60
66
  /**
61
67
  * Common files attached to every run (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION path_part ids). Like ``instruction_path_part_id``, this is the exception to PUT semantics: null (or omit) retains the stored list; pass [] to clear; pass a list to replace it wholesale. The caller must be able to read each one.
62
68
  * @type {Array<string>}
@@ -29,6 +29,10 @@ exports.UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
29
29
  minimum: 60,
30
30
  exclusiveMinimum: false,
31
31
  },
32
+ selectedSkillIds: {
33
+ maxItems: 20,
34
+ uniqueItems: false,
35
+ },
32
36
  commonFilePathPartIds: {
33
37
  maxItems: 20,
34
38
  uniqueItems: false,
@@ -61,6 +65,7 @@ function UpdateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscriminator)
61
65
  'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
62
66
  'isActive': json['is_active'],
63
67
  'approvalRequired': json['approval_required'],
68
+ 'selectedSkillIds': json['selected_skill_ids'] == null ? undefined : json['selected_skill_ids'],
64
69
  'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
65
70
  };
66
71
  }
@@ -79,6 +84,7 @@ function UpdateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscriminator =
79
84
  'parent_path_part_id': value['parentPathPartId'],
80
85
  'is_active': value['isActive'],
81
86
  'approval_required': value['approvalRequired'],
87
+ 'selected_skill_ids': value['selectedSkillIds'],
82
88
  'common_file_path_part_ids': value['commonFilePathPartIds'],
83
89
  };
84
90
  }
@@ -102,6 +102,12 @@ export interface WorkflowDefinitionResponse {
102
102
  * @memberof WorkflowDefinitionResponse
103
103
  */
104
104
  isTemplate: boolean;
105
+ /**
106
+ * Skill PDO ids force-loaded into every run by default. The FE prefills these as the run's selected skills.
107
+ * @type {Array<string>}
108
+ * @memberof WorkflowDefinitionResponse
109
+ */
110
+ selectedSkillIds?: Array<string>;
105
111
  /**
106
112
  * Common files attached to every run (path_part ids). The FE renders these as 'attached to every run' on the workflow page.
107
113
  * @type {Array<string>}
@@ -88,6 +88,7 @@ function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminator) {
88
88
  'isActive': json['is_active'],
89
89
  'approvalRequired': json['approval_required'],
90
90
  'isTemplate': json['is_template'],
91
+ 'selectedSkillIds': json['selected_skill_ids'] == null ? undefined : json['selected_skill_ids'],
91
92
  'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
92
93
  'createdFromId': json['created_from_id'],
93
94
  'copyCount': json['copy_count'] == null ? undefined : json['copy_count'],
@@ -119,6 +120,7 @@ function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator = fals
119
120
  'is_active': value['isActive'],
120
121
  'approval_required': value['approvalRequired'],
121
122
  'is_template': value['isTemplate'],
123
+ 'selected_skill_ids': value['selectedSkillIds'],
122
124
  'common_file_path_part_ids': value['commonFilePathPartIds'],
123
125
  'created_from_id': value['createdFromId'],
124
126
  'copy_count': value['copyCount'],
@@ -62,6 +62,12 @@ export interface WorkflowRunSnapshot {
62
62
  * @memberof WorkflowRunSnapshot
63
63
  */
64
64
  userMessage?: string | null;
65
+ /**
66
+ * Skill PDO ids to force-load into the run at turn 0, merged with the definition's prefill. Definition selections are validated readable + SKILL at write time; every id is re-checked fail-closed when the run materializes (a skill deleted or revoked after selection is dropped, never bricking the run). The runner materializes each skill's ACTIVE published version into the agent's skills dir; the agent can still discover others via search. Empty for the common case; pre-feature snapshots default to empty.
67
+ * @type {Array<string>}
68
+ * @memberof WorkflowRunSnapshot
69
+ */
70
+ selectedSkillIds?: Array<string>;
65
71
  }
66
72
  export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
67
73
  [property: string]: {
@@ -55,6 +55,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
55
55
  'inputs': (json['inputs'].map(InputSnapshot_1.InputSnapshotFromJSON)),
56
56
  'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFile_1.ExcludedCommonFileFromJSON)),
57
57
  'userMessage': json['user_message'] == null ? undefined : json['user_message'],
58
+ 'selectedSkillIds': json['selected_skill_ids'] == null ? undefined : json['selected_skill_ids'],
58
59
  };
59
60
  }
60
61
  function WorkflowRunSnapshotToJSON(json) {
@@ -71,5 +72,6 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
71
72
  'inputs': (value['inputs'].map(InputSnapshot_1.InputSnapshotToJSON)),
72
73
  'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFile_1.ExcludedCommonFileToJSON)),
73
74
  'user_message': value['userMessage'],
75
+ 'selected_skill_ids': value['selectedSkillIds'],
74
76
  };
75
77
  }
@@ -1,6 +1,7 @@
1
1
  export * from './AcceptDisclaimerRequest';
2
2
  export * from './AcceptInviteResponse';
3
3
  export * from './AccessCheckResponse';
4
+ export * from './ActivateSkillVersionRequest';
4
5
  export * from './AddMemberRequest';
5
6
  export * from './AncestryResponse';
6
7
  export * from './ApiAuthConfig';
@@ -62,6 +63,7 @@ export * from './CreatePasswordUserRequest';
62
63
  export * from './CreatePermissionRequest';
63
64
  export * from './CreatePhonePasswordUserRequest';
64
65
  export * from './CreateSectionRequest';
66
+ export * from './CreateSkillRequest';
65
67
  export * from './CreateTagRequest';
66
68
  export * from './CreateThreadMessageRequest';
67
69
  export * from './CreateThreadRequest';
@@ -122,7 +124,7 @@ export * from './FeedbackTargetType';
122
124
  export * from './FolderAction';
123
125
  export * from './FolderActionResponse';
124
126
  export * from './FolderResponse';
125
- export * from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse';
127
+ export * from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR';
126
128
  export * from './GroupMemberOrder';
127
129
  export * from './GroupPermissionOrder';
128
130
  export * from './GroupPermissionResponse';
@@ -166,7 +168,7 @@ export * from './NetworkClass';
166
168
  export * from './NonFilesystemReferenceType';
167
169
  export * from './OnboardingCompanyRequest';
168
170
  export * from './OnboardingProfileRequest';
169
- export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator';
171
+ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat';
170
172
  export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
171
173
  export * from './PaginatedResponseDocumentResponse';
172
174
  export * from './PaginatedResponseDocumentVersionResponse';
@@ -181,6 +183,7 @@ export * from './PaginatedResponseMemoryChunkResponse';
181
183
  export * from './PaginatedResponsePathPartResponse';
182
184
  export * from './PaginatedResponsePendingMemoryChunkResponse';
183
185
  export * from './PaginatedResponsePermissionResponse';
186
+ export * from './PaginatedResponseSkillResponse';
184
187
  export * from './PaginatedResponseTagResponse';
185
188
  export * from './PaginatedResponseTenantResponse';
186
189
  export * from './PaginatedResponseTenantUserResponse';
@@ -225,6 +228,8 @@ export * from './RunFolder';
225
228
  export * from './RunFolderRef';
226
229
  export * from './SSOInitiateResponse';
227
230
  export * from './ScoredChunkResponse';
231
+ export * from './SearchSkillsRequest';
232
+ export * from './SearchSkillsResponse';
228
233
  export * from './SearchSortOrder';
229
234
  export * from './SearchTablesRequest';
230
235
  export * from './SearchTablesResponse';
@@ -240,6 +245,11 @@ export * from './SetApprovalStateRequest';
240
245
  export * from './SetWorkflowRunApprovalRequest';
241
246
  export * from './SheetVisibilityChange';
242
247
  export * from './SignInRequest';
248
+ export * from './SkillOrder';
249
+ export * from './SkillResponse';
250
+ export * from './SkillScriptFile';
251
+ export * from './SkillSearchResult';
252
+ export * from './SkillVersionResponse';
243
253
  export * from './SortDirection';
244
254
  export * from './StartWorkflowRunRequest';
245
255
  export * from './Step';
@@ -296,6 +306,7 @@ export * from './UpdateGroupRequest';
296
306
  export * from './UpdateInviteRequest';
297
307
  export * from './UpdatePermissionRequest';
298
308
  export * from './UpdateSectionRequest';
309
+ export * from './UpdateSkillRequest';
299
310
  export * from './UpdateTableRequest';
300
311
  export * from './UpdateTagRequest';
301
312
  export * from './UpdateTenantRequest';
@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  __exportStar(require("./AcceptDisclaimerRequest"), exports);
20
20
  __exportStar(require("./AcceptInviteResponse"), exports);
21
21
  __exportStar(require("./AccessCheckResponse"), exports);
22
+ __exportStar(require("./ActivateSkillVersionRequest"), exports);
22
23
  __exportStar(require("./AddMemberRequest"), exports);
23
24
  __exportStar(require("./AncestryResponse"), exports);
24
25
  __exportStar(require("./ApiAuthConfig"), exports);
@@ -80,6 +81,7 @@ __exportStar(require("./CreatePasswordUserRequest"), exports);
80
81
  __exportStar(require("./CreatePermissionRequest"), exports);
81
82
  __exportStar(require("./CreatePhonePasswordUserRequest"), exports);
82
83
  __exportStar(require("./CreateSectionRequest"), exports);
84
+ __exportStar(require("./CreateSkillRequest"), exports);
83
85
  __exportStar(require("./CreateTagRequest"), exports);
84
86
  __exportStar(require("./CreateThreadMessageRequest"), exports);
85
87
  __exportStar(require("./CreateThreadRequest"), exports);
@@ -140,7 +142,7 @@ __exportStar(require("./FeedbackTargetType"), exports);
140
142
  __exportStar(require("./FolderAction"), exports);
141
143
  __exportStar(require("./FolderActionResponse"), exports);
142
144
  __exportStar(require("./FolderResponse"), exports);
143
- __exportStar(require("./FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse"), exports);
145
+ __exportStar(require("./FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR"), exports);
144
146
  __exportStar(require("./GroupMemberOrder"), exports);
145
147
  __exportStar(require("./GroupPermissionOrder"), exports);
146
148
  __exportStar(require("./GroupPermissionResponse"), exports);
@@ -184,7 +186,7 @@ __exportStar(require("./NetworkClass"), exports);
184
186
  __exportStar(require("./NonFilesystemReferenceType"), exports);
185
187
  __exportStar(require("./OnboardingCompanyRequest"), exports);
186
188
  __exportStar(require("./OnboardingProfileRequest"), exports);
187
- __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator"), exports);
189
+ __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat"), exports);
188
190
  __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
189
191
  __exportStar(require("./PaginatedResponseDocumentResponse"), exports);
190
192
  __exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
@@ -199,6 +201,7 @@ __exportStar(require("./PaginatedResponseMemoryChunkResponse"), exports);
199
201
  __exportStar(require("./PaginatedResponsePathPartResponse"), exports);
200
202
  __exportStar(require("./PaginatedResponsePendingMemoryChunkResponse"), exports);
201
203
  __exportStar(require("./PaginatedResponsePermissionResponse"), exports);
204
+ __exportStar(require("./PaginatedResponseSkillResponse"), exports);
202
205
  __exportStar(require("./PaginatedResponseTagResponse"), exports);
203
206
  __exportStar(require("./PaginatedResponseTenantResponse"), exports);
204
207
  __exportStar(require("./PaginatedResponseTenantUserResponse"), exports);
@@ -243,6 +246,8 @@ __exportStar(require("./RunFolder"), exports);
243
246
  __exportStar(require("./RunFolderRef"), exports);
244
247
  __exportStar(require("./SSOInitiateResponse"), exports);
245
248
  __exportStar(require("./ScoredChunkResponse"), exports);
249
+ __exportStar(require("./SearchSkillsRequest"), exports);
250
+ __exportStar(require("./SearchSkillsResponse"), exports);
246
251
  __exportStar(require("./SearchSortOrder"), exports);
247
252
  __exportStar(require("./SearchTablesRequest"), exports);
248
253
  __exportStar(require("./SearchTablesResponse"), exports);
@@ -258,6 +263,11 @@ __exportStar(require("./SetApprovalStateRequest"), exports);
258
263
  __exportStar(require("./SetWorkflowRunApprovalRequest"), exports);
259
264
  __exportStar(require("./SheetVisibilityChange"), exports);
260
265
  __exportStar(require("./SignInRequest"), exports);
266
+ __exportStar(require("./SkillOrder"), exports);
267
+ __exportStar(require("./SkillResponse"), exports);
268
+ __exportStar(require("./SkillScriptFile"), exports);
269
+ __exportStar(require("./SkillSearchResult"), exports);
270
+ __exportStar(require("./SkillVersionResponse"), exports);
261
271
  __exportStar(require("./SortDirection"), exports);
262
272
  __exportStar(require("./StartWorkflowRunRequest"), exports);
263
273
  __exportStar(require("./Step"), exports);
@@ -314,6 +324,7 @@ __exportStar(require("./UpdateGroupRequest"), exports);
314
324
  __exportStar(require("./UpdateInviteRequest"), exports);
315
325
  __exportStar(require("./UpdatePermissionRequest"), exports);
316
326
  __exportStar(require("./UpdateSectionRequest"), exports);
327
+ __exportStar(require("./UpdateSkillRequest"), exports);
317
328
  __exportStar(require("./UpdateTableRequest"), exports);
318
329
  __exportStar(require("./UpdateTagRequest"), exports);
319
330
  __exportStar(require("./UpdateTenantRequest"), exports);
@@ -0,0 +1,35 @@
1
+
2
+ # ActivateSkillVersionRequest
3
+
4
+ Activate a specific published version.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `confirmDiscardUnpublished` | boolean
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { ActivateSkillVersionRequest } from '@knowledge-stack/ksapi'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "confirmDiscardUnpublished": null,
20
+ } satisfies ActivateSkillVersionRequest
21
+
22
+ console.log(example)
23
+
24
+ // Convert the instance to a JSON string
25
+ const exampleJSON: string = JSON.stringify(example)
26
+ console.log(exampleJSON)
27
+
28
+ // Parse the JSON string back to an object
29
+ const exampleParsed = JSON.parse(exampleJSON) as ActivateSkillVersionRequest
30
+ console.log(exampleParsed)
31
+ ```
32
+
33
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
34
+
35
+
package/docs/ChunksApi.md CHANGED
@@ -304,7 +304,7 @@ example().catch(console.error);
304
304
  | **chunkId** | `string` | | [Defaults to `undefined`] |
305
305
  | **prev** | `number` | Number of preceding items to include (max 50). | [Optional] [Defaults to `1`] |
306
306
  | **next** | `number` | Number of succeeding items to include (max 50). | [Optional] [Defaults to `1`] |
307
- | **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION] |
307
+ | **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION, SKILL] |
308
308
  | **withinSection** | `boolean` | When true (default), traverse only the anchor\&#39;s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. | [Optional] [Defaults to `true`] |
309
309
 
310
310
  ### Return type
@@ -0,0 +1,39 @@
1
+
2
+ # CreateSkillRequest
3
+
4
+ Author a skill from a SKILL.md bundle.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `name` | string
11
+ `skillMd` | string
12
+ `scripts` | [Array&lt;SkillScriptFile&gt;](SkillScriptFile.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { CreateSkillRequest } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "name": null,
22
+ "skillMd": null,
23
+ "scripts": null,
24
+ } satisfies CreateSkillRequest
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as CreateSkillRequest
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -14,6 +14,7 @@ Name | Type
14
14
  `instructionPathPartId` | string
15
15
  `approvalRequired` | boolean
16
16
  `isTemplate` | boolean
17
+ `selectedSkillIds` | Array&lt;string&gt;
17
18
  `commonFilePathPartIds` | Array&lt;string&gt;
18
19
 
19
20
  ## Example
@@ -30,6 +31,7 @@ const example = {
30
31
  "instructionPathPartId": null,
31
32
  "approvalRequired": null,
32
33
  "isTemplate": null,
34
+ "selectedSkillIds": null,
33
35
  "commonFilePathPartIds": null,
34
36
  } satisfies CreateWorkflowDefinitionRequest
35
37
 
@@ -1,5 +1,5 @@
1
1
 
2
- # FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
2
+ # FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
3
3
 
4
4
 
5
5
  ## Properties
@@ -32,6 +32,7 @@ Name | Type
32
32
  `isActive` | boolean
33
33
  `approvalRequired` | boolean
34
34
  `isTemplate` | boolean
35
+ `selectedSkillIds` | Array&lt;string&gt;
35
36
  `commonFilePathPartIds` | Array&lt;string&gt;
36
37
  `createdFromId` | string
37
38
  `copyCount` | number
@@ -63,11 +64,14 @@ Name | Type
63
64
  `apiDocs` | string
64
65
  `disclaimerAcceptedAt` | Date
65
66
  `disclaimerAcceptedBy` | string
67
+ `skillMd` | string
68
+ `scriptNames` | Array&lt;string&gt;
69
+ `hasUnpublishedChanges` | boolean
66
70
 
67
71
  ## Example
68
72
 
69
73
  ```typescript
70
- import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
74
+ import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR } from '@knowledge-stack/ksapi'
71
75
 
72
76
  // TODO: Update the object below with actual values
73
77
  const example = {
@@ -97,6 +101,7 @@ const example = {
97
101
  "isActive": null,
98
102
  "approvalRequired": null,
99
103
  "isTemplate": null,
104
+ "selectedSkillIds": null,
100
105
  "commonFilePathPartIds": null,
101
106
  "createdFromId": null,
102
107
  "copyCount": null,
@@ -128,7 +133,10 @@ const example = {
128
133
  "apiDocs": null,
129
134
  "disclaimerAcceptedAt": null,
130
135
  "disclaimerAcceptedBy": null,
131
- } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
136
+ "skillMd": null,
137
+ "scriptNames": null,
138
+ "hasUnpublishedChanges": null,
139
+ } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
132
140
 
133
141
  console.log(example)
134
142
 
@@ -137,7 +145,7 @@ const exampleJSON: string = JSON.stringify(example)
137
145
  console.log(exampleJSON)
138
146
 
139
147
  // Parse the JSON string back to an object
140
- const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
148
+ const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
141
149
  console.log(exampleParsed)
142
150
  ```
143
151
 
@@ -321,7 +321,7 @@ example().catch(console.error);
321
321
 
322
322
  ## listFolderContents
323
323
 
324
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, sortDir, ownerId, nameLike, withTags, limit, offset, approvalState, includeTagIds, excludeTagIds, createdAfter, createdBefore, updatedAfter, updatedBefore)
324
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat listFolderContents(folderId, maxDepth, sortOrder, sortDir, ownerId, nameLike, withTags, limit, offset, approvalState, includeTagIds, excludeTagIds, createdAfter, createdBefore, updatedAfter, updatedBefore)
325
325
 
326
326
  List Folder Contents Handler
327
327
 
@@ -417,7 +417,7 @@ example().catch(console.error);
417
417
 
418
418
  ### Return type
419
419
 
420
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
420
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md)
421
421
 
422
422
  ### Authorization
423
423
 
@@ -546,7 +546,7 @@ example().catch(console.error);
546
546
 
547
547
  ## searchItems
548
548
 
549
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
549
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
550
550
 
551
551
  Search Items Handler
552
552
 
@@ -615,7 +615,7 @@ example().catch(console.error);
615
615
 
616
616
  ### Return type
617
617
 
618
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
618
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md)
619
619
 
620
620
  ### Authorization
621
621