@knowledge-stack/ksapi 1.139.0 → 1.140.0

package/dist/esm/models/LeaderboardEntry.js

@@ -0,0 +1,52 @@
+/* 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 LeaderboardEntryPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the LeaderboardEntry interface.
+ */
+export function instanceOfLeaderboardEntry(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+export function LeaderboardEntryFromJSON(json) {
+    return LeaderboardEntryFromJSONTyped(json, false);
+}
+export function LeaderboardEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'count': json['count'],
+    };
+}
+export function LeaderboardEntryToJSON(json) {
+    return LeaderboardEntryToJSONTyped(json, false);
+}
+export function LeaderboardEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'count': value['count'],
+    };
+}

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

@@ -0,0 +1,61 @@
+/**
+ * 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 type { TimeseriesPoint } from './TimeseriesPoint';
+import type { TimeBucket } from './TimeBucket';
+/**
+ * Workflow runs bucketed over time.
+ * @export
+ * @interface RunTimeseriesResponse
+ */
+export interface RunTimeseriesResponse {
+    /**
+     * IANA timezone the buckets are in.
+     * @type {string}
+     * @memberof RunTimeseriesResponse
+     */
+    timezone: string;
+    /**
+     *
+     * @type {TimeBucket}
+     * @memberof RunTimeseriesResponse
+     */
+    bucket: TimeBucket;
+    /**
+     *
+     * @type {Array<TimeseriesPoint>}
+     * @memberof RunTimeseriesResponse
+     */
+    points?: Array<TimeseriesPoint>;
+}
+export declare const RunTimeseriesResponsePropertyValidationAttributesMap: {
+    [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 RunTimeseriesResponse interface.
+ */
+export declare function instanceOfRunTimeseriesResponse(value: object): value is RunTimeseriesResponse;
+export declare function RunTimeseriesResponseFromJSON(json: any): RunTimeseriesResponse;
+export declare function RunTimeseriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunTimeseriesResponse;
+export declare function RunTimeseriesResponseToJSON(json: any): RunTimeseriesResponse;
+export declare function RunTimeseriesResponseToJSONTyped(value?: RunTimeseriesResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RunTimeseriesResponse.js

@@ -0,0 +1,52 @@
+/* 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 { TimeseriesPointFromJSON, TimeseriesPointToJSON, } from './TimeseriesPoint';
+import { TimeBucketFromJSON, TimeBucketToJSON, } from './TimeBucket';
+export const RunTimeseriesResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the RunTimeseriesResponse interface.
+ */
+export function instanceOfRunTimeseriesResponse(value) {
+    if (!('timezone' in value) || value['timezone'] === undefined)
+        return false;
+    if (!('bucket' in value) || value['bucket'] === undefined)
+        return false;
+    return true;
+}
+export function RunTimeseriesResponseFromJSON(json) {
+    return RunTimeseriesResponseFromJSONTyped(json, false);
+}
+export function RunTimeseriesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'timezone': json['timezone'],
+        'bucket': TimeBucketFromJSON(json['bucket']),
+        'points': json['points'] == null ? undefined : (json['points'].map(TimeseriesPointFromJSON)),
+    };
+}
+export function RunTimeseriesResponseToJSON(json) {
+    return RunTimeseriesResponseToJSONTyped(json, false);
+}
+export function RunTimeseriesResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'timezone': value['timezone'],
+        'bucket': TimeBucketToJSON(value['bucket']),
+        'points': value['points'] == null ? undefined : (value['points'].map(TimeseriesPointToJSON)),
+    };
+}

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ItemPermissions } from './ItemPermissions';
+import type { SkillScriptFile } from './SkillScriptFile';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 import type { UserInfo } from './UserInfo';
 /**
@@ -78,6 +79,12 @@ export interface SkillResponse {
      * @memberof SkillResponse
      */
     scriptNames?: Array<string>;
+    /**
+     * Bundled scripts with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current script set so a PATCH can safely resubmit the whole set.
+     * @type {Array<SkillScriptFile>}
+     * @memberof SkillResponse
+     */
+    scripts?: Array<SkillScriptFile> | null;
     /**
      * 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

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
+import { SkillScriptFileFromJSON, SkillScriptFileToJSON, } from './SkillScriptFile';
 import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
 import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
 /**
@@ -65,6 +66,7 @@ export function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'],
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
         'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
+        'scripts': json['scripts'] == null ? undefined : (json['scripts'].map(SkillScriptFileFromJSON)),
         'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -91,6 +93,7 @@ export function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'skill_md': value['skillMd'],
         'script_names': value['scriptNames'],
+        'scripts': value['scripts'] == null ? undefined : (value['scripts'].map(SkillScriptFileToJSON)),
         'has_unpublished_changes': value['hasUnpublishedChanges'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
         'owner': UserInfoToJSON(value['owner']),

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

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+/**
+ * Granularity for a bucketed time series.
+ * @export
+ */
+export declare const TimeBucket: {
+    readonly Hour: 'hour';
+    readonly Day: 'day';
+    readonly Week: 'week';
+    readonly Month: 'month';
+};
+export type TimeBucket = typeof TimeBucket[keyof typeof TimeBucket];
+export declare function instanceOfTimeBucket(value: any): boolean;
+export declare function TimeBucketFromJSON(json: any): TimeBucket;
+export declare function TimeBucketFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeBucket;
+export declare function TimeBucketToJSON(value?: TimeBucket | null): any;
+export declare function TimeBucketToJSONTyped(value: any, ignoreDiscriminator: boolean): TimeBucket;

package/dist/esm/models/TimeBucket.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Granularity for a bucketed time series.
+ * @export
+ */
+export const TimeBucket = {
+    Hour: 'hour',
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+export function instanceOfTimeBucket(value) {
+    for (const key in TimeBucket) {
+        if (Object.prototype.hasOwnProperty.call(TimeBucket, key)) {
+            if (TimeBucket[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function TimeBucketFromJSON(json) {
+    return TimeBucketFromJSONTyped(json, false);
+}
+export function TimeBucketFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function TimeBucketToJSON(value) {
+    return value;
+}
+export function TimeBucketToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/TimeseriesPoint.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.
+ */
+/**
+ * One bucket of a time series.
+ * @export
+ * @interface TimeseriesPoint
+ */
+export interface TimeseriesPoint {
+    /**
+     * Start of the bucket, in the resolved timezone.
+     * @type {Date}
+     * @memberof TimeseriesPoint
+     */
+    bucketStart: Date;
+    /**
+     * Row count in this bucket.
+     * @type {number}
+     * @memberof TimeseriesPoint
+     */
+    count: number;
+}
+export declare const TimeseriesPointPropertyValidationAttributesMap: {
+    [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 TimeseriesPoint interface.
+ */
+export declare function instanceOfTimeseriesPoint(value: object): value is TimeseriesPoint;
+export declare function TimeseriesPointFromJSON(json: any): TimeseriesPoint;
+export declare function TimeseriesPointFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeseriesPoint;
+export declare function TimeseriesPointToJSON(json: any): TimeseriesPoint;
+export declare function TimeseriesPointToJSONTyped(value?: TimeseriesPoint | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TimeseriesPoint.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 TimeseriesPointPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the TimeseriesPoint interface.
+ */
+export function instanceOfTimeseriesPoint(value) {
+    if (!('bucketStart' in value) || value['bucketStart'] === undefined)
+        return false;
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+export function TimeseriesPointFromJSON(json) {
+    return TimeseriesPointFromJSONTyped(json, false);
+}
+export function TimeseriesPointFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'bucketStart': (new Date(json['bucket_start'])),
+        'count': json['count'],
+    };
+}
+export function TimeseriesPointToJSON(json) {
+    return TimeseriesPointToJSONTyped(json, false);
+}
+export function TimeseriesPointToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'bucket_start': value['bucketStart'].toISOString(),
+        'count': value['count'],
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 type { LeaderboardEntry } from './LeaderboardEntry';
+/**
+ * Top workflows and top users by run count over a window.
+ * @export
+ * @interface WorkflowLeaderboardResponse
+ */
+export interface WorkflowLeaderboardResponse {
+    /**
+     *
+     * @type {Array<LeaderboardEntry>}
+     * @memberof WorkflowLeaderboardResponse
+     */
+    topWorkflows?: Array<LeaderboardEntry>;
+    /**
+     *
+     * @type {Array<LeaderboardEntry>}
+     * @memberof WorkflowLeaderboardResponse
+     */
+    topUsers?: Array<LeaderboardEntry>;
+}
+export declare const WorkflowLeaderboardResponsePropertyValidationAttributesMap: {
+    [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 WorkflowLeaderboardResponse interface.
+ */
+export declare function instanceOfWorkflowLeaderboardResponse(value: object): value is WorkflowLeaderboardResponse;
+export declare function WorkflowLeaderboardResponseFromJSON(json: any): WorkflowLeaderboardResponse;
+export declare function WorkflowLeaderboardResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowLeaderboardResponse;
+export declare function WorkflowLeaderboardResponseToJSON(json: any): WorkflowLeaderboardResponse;
+export declare function WorkflowLeaderboardResponseToJSONTyped(value?: WorkflowLeaderboardResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowLeaderboardResponse.js

@@ -0,0 +1,45 @@
+/* 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 { LeaderboardEntryFromJSON, LeaderboardEntryToJSON, } from './LeaderboardEntry';
+export const WorkflowLeaderboardResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowLeaderboardResponse interface.
+ */
+export function instanceOfWorkflowLeaderboardResponse(value) {
+    return true;
+}
+export function WorkflowLeaderboardResponseFromJSON(json) {
+    return WorkflowLeaderboardResponseFromJSONTyped(json, false);
+}
+export function WorkflowLeaderboardResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'topWorkflows': json['top_workflows'] == null ? undefined : (json['top_workflows'].map(LeaderboardEntryFromJSON)),
+        'topUsers': json['top_users'] == null ? undefined : (json['top_users'].map(LeaderboardEntryFromJSON)),
+    };
+}
+export function WorkflowLeaderboardResponseToJSON(json) {
+    return WorkflowLeaderboardResponseToJSONTyped(json, false);
+}
+export function WorkflowLeaderboardResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'top_workflows': value['topWorkflows'] == null ? undefined : (value['topWorkflows'].map(LeaderboardEntryToJSON)),
+        'top_users': value['topUsers'] == null ? undefined : (value['topUsers'].map(LeaderboardEntryToJSON)),
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 type { DefinitionOutputStat } from './DefinitionOutputStat';
+/**
+ * Avg documents generated per workflow definition (completed runs).
+ * @export
+ * @interface WorkflowOutputStatsResponse
+ */
+export interface WorkflowOutputStatsResponse {
+    /**
+     *
+     * @type {Array<DefinitionOutputStat>}
+     * @memberof WorkflowOutputStatsResponse
+     */
+    perDefinition?: Array<DefinitionOutputStat>;
+    /**
+     * Mean output DOCUMENTs across all completed runs; null when none.
+     * @type {number}
+     * @memberof WorkflowOutputStatsResponse
+     */
+    overallAvg: number | null;
+}
+export declare const WorkflowOutputStatsResponsePropertyValidationAttributesMap: {
+    [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 WorkflowOutputStatsResponse interface.
+ */
+export declare function instanceOfWorkflowOutputStatsResponse(value: object): value is WorkflowOutputStatsResponse;
+export declare function WorkflowOutputStatsResponseFromJSON(json: any): WorkflowOutputStatsResponse;
+export declare function WorkflowOutputStatsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowOutputStatsResponse;
+export declare function WorkflowOutputStatsResponseToJSON(json: any): WorkflowOutputStatsResponse;
+export declare function WorkflowOutputStatsResponseToJSONTyped(value?: WorkflowOutputStatsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowOutputStatsResponse.js

@@ -0,0 +1,47 @@
+/* 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 { DefinitionOutputStatFromJSON, DefinitionOutputStatToJSON, } from './DefinitionOutputStat';
+export const WorkflowOutputStatsResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowOutputStatsResponse interface.
+ */
+export function instanceOfWorkflowOutputStatsResponse(value) {
+    if (!('overallAvg' in value) || value['overallAvg'] === undefined)
+        return false;
+    return true;
+}
+export function WorkflowOutputStatsResponseFromJSON(json) {
+    return WorkflowOutputStatsResponseFromJSONTyped(json, false);
+}
+export function WorkflowOutputStatsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'perDefinition': json['per_definition'] == null ? undefined : (json['per_definition'].map(DefinitionOutputStatFromJSON)),
+        'overallAvg': json['overall_avg'],
+    };
+}
+export function WorkflowOutputStatsResponseToJSON(json) {
+    return WorkflowOutputStatsResponseToJSONTyped(json, false);
+}
+export function WorkflowOutputStatsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'per_definition': value['perDefinition'] == null ? undefined : (value['perDefinition'].map(DefinitionOutputStatToJSON)),
+        'overall_avg': value['overallAvg'],
+    };
+}