@knowledge-stack/ksapi 3.15.0 → 3.16.0

package/.openapi-generator/FILES

@@ -331,6 +331,7 @@ docs/SheetVisibilityChange.md
 docs/SignInRequest.md
 docs/SignUpResponse.md
 docs/SkillFile.md
+docs/SkillFileDocument.md
 docs/SkillOrder.md
 docs/SkillResponse.md
 docs/SkillSearchResult.md
@@ -810,6 +811,7 @@ src/models/SheetVisibilityChange.ts
 src/models/SignInRequest.ts
 src/models/SignUpResponse.ts
 src/models/SkillFile.ts
+src/models/SkillFileDocument.ts
 src/models/SkillOrder.ts
 src/models/SkillResponse.ts
 src/models/SkillSearchResult.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@3.15.0
+# @knowledge-stack/ksapi@3.16.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -614,6 +614,7 @@ All URIs are relative to *http://localhost:8000*
 - [SignInRequest](docs/SignInRequest.md)
 - [SignUpResponse](docs/SignUpResponse.md)
 - [SkillFile](docs/SkillFile.md)
+- [SkillFileDocument](docs/SkillFileDocument.md)
 - [SkillOrder](docs/SkillOrder.md)
 - [SkillResponse](docs/SkillResponse.md)
 - [SkillSearchResult](docs/SkillSearchResult.md)
@@ -756,7 +757,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `3.15.0`
+- Package version: `3.16.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/esm/models/SkillFileDocument.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SkillFileDocument
+ */
+export interface SkillFileDocument {
+    /**
+     * Path relative to the skill root, e.g. SKILL.md
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    path: string;
+    /**
+     * The file's Document id, as used in an @[doc:<id>] reference
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    documentId: string;
+}
+export declare const SkillFileDocumentPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the SkillFileDocument interface.
+ */
+export declare function instanceOfSkillFileDocument(value: object): value is SkillFileDocument;
+export declare function SkillFileDocumentFromJSON(json: any): SkillFileDocument;
+export declare function SkillFileDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillFileDocument;
+export declare function SkillFileDocumentToJSON(json: any): SkillFileDocument;
+export declare function SkillFileDocumentToJSONTyped(value?: SkillFileDocument | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SkillFileDocument.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const SkillFileDocumentPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SkillFileDocument interface.
+ */
+export function instanceOfSkillFileDocument(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('documentId' in value) || value['documentId'] === undefined)
+        return false;
+    return true;
+}
+export function SkillFileDocumentFromJSON(json) {
+    return SkillFileDocumentFromJSONTyped(json, false);
+}
+export function SkillFileDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'documentId': json['document_id'],
+    };
+}
+export function SkillFileDocumentToJSON(json) {
+    return SkillFileDocumentToJSONTyped(json, false);
+}
+export function SkillFileDocumentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'document_id': value['documentId'],
+    };
+}

package/dist/esm/models/SkillResponse.d.ts

@@ -13,6 +13,7 @@ import type { ItemPermissions } from './ItemPermissions';
 import type { SkillFile } from './SkillFile';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 import type { UserInfo } from './UserInfo';
+import type { SkillFileDocument } from './SkillFileDocument';
 /**
  * Skill response; ``part_type`` is the folder-listing discriminator.
  * @export
@@ -85,6 +86,12 @@ export interface SkillResponse {
      * @memberof SkillResponse
      */
     files?: Array<SkillFile> | null;
+    /**
+     * Every working file with its Document id, SKILL.md included, sorted by path; populated with file_paths, empty on list.
+     * @type {Array<SkillFileDocument>}
+     * @memberof SkillResponse
+     */
+    fileDocuments?: Array<SkillFileDocument>;
     /**
      * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
      * @type {boolean}

package/dist/esm/models/SkillResponse.js

@@ -15,6 +15,7 @@ import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissio
 import { SkillFileFromJSON, SkillFileToJSON, } from './SkillFile';
 import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
 import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
+import { SkillFileDocumentFromJSON, SkillFileDocumentToJSON, } from './SkillFileDocument';
 /**
  * @export
  */
@@ -67,6 +68,7 @@ export function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
         'filePaths': json['file_paths'] == null ? undefined : json['file_paths'],
         'files': json['files'] == null ? undefined : (json['files'].map(SkillFileFromJSON)),
+        'fileDocuments': json['file_documents'] == null ? undefined : (json['file_documents'].map(SkillFileDocumentFromJSON)),
         'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -94,6 +96,7 @@ export function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'skill_md': value['skillMd'],
         'file_paths': value['filePaths'],
         'files': value['files'] == null ? undefined : (value['files'].map(SkillFileToJSON)),
+        'file_documents': value['fileDocuments'] == null ? undefined : (value['fileDocuments'].map(SkillFileDocumentToJSON)),
         'has_unpublished_changes': value['hasUnpublishedChanges'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
         'owner': UserInfoToJSON(value['owner']),

package/dist/esm/models/index.d.ts

@@ -299,6 +299,7 @@ export * from './SheetVisibilityChange';
 export * from './SignInRequest';
 export * from './SignUpResponse';
 export * from './SkillFile';
+export * from './SkillFileDocument';
 export * from './SkillOrder';
 export * from './SkillResponse';
 export * from './SkillSearchResult';

package/dist/esm/models/index.js

@@ -301,6 +301,7 @@ export * from './SheetVisibilityChange';
 export * from './SignInRequest';
 export * from './SignUpResponse';
 export * from './SkillFile';
+export * from './SkillFileDocument';
 export * from './SkillOrder';
 export * from './SkillResponse';
 export * from './SkillSearchResult';

package/dist/models/SkillFileDocument.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SkillFileDocument
+ */
+export interface SkillFileDocument {
+    /**
+     * Path relative to the skill root, e.g. SKILL.md
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    path: string;
+    /**
+     * The file's Document id, as used in an @[doc:<id>] reference
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    documentId: string;
+}
+export declare const SkillFileDocumentPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the SkillFileDocument interface.
+ */
+export declare function instanceOfSkillFileDocument(value: object): value is SkillFileDocument;
+export declare function SkillFileDocumentFromJSON(json: any): SkillFileDocument;
+export declare function SkillFileDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillFileDocument;
+export declare function SkillFileDocumentToJSON(json: any): SkillFileDocument;
+export declare function SkillFileDocumentToJSONTyped(value?: SkillFileDocument | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SkillFileDocument.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkillFileDocumentPropertyValidationAttributesMap = void 0;
+exports.instanceOfSkillFileDocument = instanceOfSkillFileDocument;
+exports.SkillFileDocumentFromJSON = SkillFileDocumentFromJSON;
+exports.SkillFileDocumentFromJSONTyped = SkillFileDocumentFromJSONTyped;
+exports.SkillFileDocumentToJSON = SkillFileDocumentToJSON;
+exports.SkillFileDocumentToJSONTyped = SkillFileDocumentToJSONTyped;
+exports.SkillFileDocumentPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SkillFileDocument interface.
+ */
+function instanceOfSkillFileDocument(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('documentId' in value) || value['documentId'] === undefined)
+        return false;
+    return true;
+}
+function SkillFileDocumentFromJSON(json) {
+    return SkillFileDocumentFromJSONTyped(json, false);
+}
+function SkillFileDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'documentId': json['document_id'],
+    };
+}
+function SkillFileDocumentToJSON(json) {
+    return SkillFileDocumentToJSONTyped(json, false);
+}
+function SkillFileDocumentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'document_id': value['documentId'],
+    };
+}

package/dist/models/SkillResponse.d.ts

@@ -13,6 +13,7 @@ import type { ItemPermissions } from './ItemPermissions';
 import type { SkillFile } from './SkillFile';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 import type { UserInfo } from './UserInfo';
+import type { SkillFileDocument } from './SkillFileDocument';
 /**
  * Skill response; ``part_type`` is the folder-listing discriminator.
  * @export
@@ -85,6 +86,12 @@ export interface SkillResponse {
      * @memberof SkillResponse
      */
     files?: Array<SkillFile> | null;
+    /**
+     * Every working file with its Document id, SKILL.md included, sorted by path; populated with file_paths, empty on list.
+     * @type {Array<SkillFileDocument>}
+     * @memberof SkillResponse
+     */
+    fileDocuments?: Array<SkillFileDocument>;
     /**
      * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
      * @type {boolean}

package/dist/models/SkillResponse.js

@@ -23,6 +23,7 @@ const ItemPermissions_1 = require("./ItemPermissions");
 const SkillFile_1 = require("./SkillFile");
 const PathPartApprovalState_1 = require("./PathPartApprovalState");
 const UserInfo_1 = require("./UserInfo");
+const SkillFileDocument_1 = require("./SkillFileDocument");
 /**
  * @export
  */
@@ -75,6 +76,7 @@ function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
         'filePaths': json['file_paths'] == null ? undefined : json['file_paths'],
         'files': json['files'] == null ? undefined : (json['files'].map(SkillFile_1.SkillFileFromJSON)),
+        'fileDocuments': json['file_documents'] == null ? undefined : (json['file_documents'].map(SkillFileDocument_1.SkillFileDocumentFromJSON)),
         'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
         'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
         'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
@@ -102,6 +104,7 @@ function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'skill_md': value['skillMd'],
         'file_paths': value['filePaths'],
         'files': value['files'] == null ? undefined : (value['files'].map(SkillFile_1.SkillFileToJSON)),
+        'file_documents': value['fileDocuments'] == null ? undefined : (value['fileDocuments'].map(SkillFileDocument_1.SkillFileDocumentToJSON)),
         'has_unpublished_changes': value['hasUnpublishedChanges'],
         'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
         'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),

package/dist/models/index.d.ts

@@ -299,6 +299,7 @@ export * from './SheetVisibilityChange';
 export * from './SignInRequest';
 export * from './SignUpResponse';
 export * from './SkillFile';
+export * from './SkillFileDocument';
 export * from './SkillOrder';
 export * from './SkillResponse';
 export * from './SkillSearchResult';

package/dist/models/index.js

@@ -317,6 +317,7 @@ __exportStar(require("./SheetVisibilityChange"), exports);
 __exportStar(require("./SignInRequest"), exports);
 __exportStar(require("./SignUpResponse"), exports);
 __exportStar(require("./SkillFile"), exports);
+__exportStar(require("./SkillFileDocument"), exports);
 __exportStar(require("./SkillOrder"), exports);
 __exportStar(require("./SkillResponse"), exports);
 __exportStar(require("./SkillSearchResult"), exports);

package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md

@@ -75,6 +75,7 @@ Name | Type
 `skillMd` | string
 `filePaths` | Array<string>
 `files` | [Array<SkillFile>](SkillFile.md)
+`fileDocuments` | [Array<SkillFileDocument>](SkillFileDocument.md)
 `hasUnpublishedChanges` | boolean
 
 ## Example
@@ -153,6 +154,7 @@ const example = {
   "skillMd": null,
   "filePaths": null,
   "files": null,
+  "fileDocuments": null,
   "hasUnpublishedChanges": null,
 } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
 

package/docs/SkillFileDocument.md

@@ -0,0 +1,36 @@
+
+# SkillFileDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`documentId` | string
+
+## Example
+
+```typescript
+import type { SkillFileDocument } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "documentId": null,
+} satisfies SkillFileDocument
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SkillFileDocument
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SkillResponse.md

@@ -18,6 +18,7 @@ Name | Type
 `skillMd` | string
 `filePaths` | Array<string>
 `files` | [Array<SkillFile>](SkillFile.md)
+`fileDocuments` | [Array<SkillFileDocument>](SkillFileDocument.md)
 `hasUnpublishedChanges` | boolean
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `owner` | [UserInfo](UserInfo.md)
@@ -43,6 +44,7 @@ const example = {
   "skillMd": null,
   "filePaths": null,
   "files": null,
+  "fileDocuments": null,
   "hasUnpublishedChanges": null,
   "approvalState": null,
   "owner": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "3.15.0",
+  "version": "3.16.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/SkillFileDocument.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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. 
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SkillFileDocument
+ */
+export interface SkillFileDocument {
+    /**
+     * Path relative to the skill root, e.g. SKILL.md
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    path: string;
+    /**
+     * The file's Document id, as used in an @[doc:<id>] reference
+     * @type {string}
+     * @memberof SkillFileDocument
+     */
+    documentId: string;
+}
+export const SkillFileDocumentPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the SkillFileDocument interface.
+ */
+export function instanceOfSkillFileDocument(value: object): value is SkillFileDocument {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    return true;
+}
+
+export function SkillFileDocumentFromJSON(json: any): SkillFileDocument {
+    return SkillFileDocumentFromJSONTyped(json, false);
+}
+
+export function SkillFileDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillFileDocument {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'documentId': json['document_id'],
+    };
+}
+
+export function SkillFileDocumentToJSON(json: any): SkillFileDocument {
+    return SkillFileDocumentToJSONTyped(json, false);
+}
+
+export function SkillFileDocumentToJSONTyped(value?: SkillFileDocument | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'document_id': value['documentId'],
+    };
+}
+

package/src/models/SkillResponse.ts

@@ -41,6 +41,13 @@ import {
     UserInfoToJSON,
     UserInfoToJSONTyped,
 } from './UserInfo';
+import type { SkillFileDocument } from './SkillFileDocument';
+import {
+    SkillFileDocumentFromJSON,
+    SkillFileDocumentFromJSONTyped,
+    SkillFileDocumentToJSON,
+    SkillFileDocumentToJSONTyped,
+} from './SkillFileDocument';
 
 /**
  * Skill response; ``part_type`` is the folder-listing discriminator.
@@ -114,6 +121,12 @@ export interface SkillResponse {
      * @memberof SkillResponse
      */
     files?: Array<SkillFile> | null;
+    /**
+     * Every working file with its Document id, SKILL.md included, sorted by path; populated with file_paths, empty on list.
+     * @type {Array<SkillFileDocument>}
+     * @memberof SkillResponse
+     */
+    fileDocuments?: Array<SkillFileDocument>;
     /**
      * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
      * @type {boolean}
@@ -217,6 +230,7 @@ export function SkillResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
         'filePaths': json['file_paths'] == null ? undefined : json['file_paths'],
         'files': json['files'] == null ? undefined : ((json['files'] as Array<any>).map(SkillFileFromJSON)),
+        'fileDocuments': json['file_documents'] == null ? undefined : ((json['file_documents'] as Array<any>).map(SkillFileDocumentFromJSON)),
         'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -248,6 +262,7 @@ export function SkillResponseToJSONTyped(value?: SkillResponse | null, ignoreDis
         'skill_md': value['skillMd'],
         'file_paths': value['filePaths'],
         'files': value['files'] == null ? undefined : ((value['files'] as Array<any>).map(SkillFileToJSON)),
+        'file_documents': value['fileDocuments'] == null ? undefined : ((value['fileDocuments'] as Array<any>).map(SkillFileDocumentToJSON)),
         'has_unpublished_changes': value['hasUnpublishedChanges'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
         'owner': UserInfoToJSON(value['owner']),

package/src/models/index.ts

@@ -301,6 +301,7 @@ export * from './SheetVisibilityChange';
 export * from './SignInRequest';
 export * from './SignUpResponse';
 export * from './SkillFile';
+export * from './SkillFileDocument';
 export * from './SkillOrder';
 export * from './SkillResponse';
 export * from './SkillSearchResult';