@knowledge-stack/ksapi 3.5.2 → 3.6.0

package/dist/models/DiagnosticTraceItem.js

@@ -0,0 +1,139 @@
+"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.DiagnosticTraceItemPropertyValidationAttributesMap = void 0;
+exports.instanceOfDiagnosticTraceItem = instanceOfDiagnosticTraceItem;
+exports.DiagnosticTraceItemFromJSON = DiagnosticTraceItemFromJSON;
+exports.DiagnosticTraceItemFromJSONTyped = DiagnosticTraceItemFromJSONTyped;
+exports.DiagnosticTraceItemToJSON = DiagnosticTraceItemToJSON;
+exports.DiagnosticTraceItemToJSONTyped = DiagnosticTraceItemToJSONTyped;
+const TraceKind_1 = require("./TraceKind");
+const DiagnosticTraceStatus_1 = require("./DiagnosticTraceStatus");
+const DiagnosticTraceFailureReason_1 = require("./DiagnosticTraceFailureReason");
+exports.DiagnosticTraceItemPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DiagnosticTraceItem interface.
+ */
+function instanceOfDiagnosticTraceItem(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('traceId' in value) || value['traceId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    return true;
+}
+function DiagnosticTraceItemFromJSON(json) {
+    return DiagnosticTraceItemFromJSONTyped(json, false);
+}
+function DiagnosticTraceItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': (0, DiagnosticTraceStatus_1.DiagnosticTraceStatusFromJSON)(json['status']),
+        'kind': (0, TraceKind_1.TraceKindFromJSON)(json['kind']),
+        'reason': json['reason'] == null ? undefined : (0, DiagnosticTraceFailureReason_1.DiagnosticTraceFailureReasonFromJSON)(json['reason']),
+        'traceId': json['trace_id'],
+        'runId': json['run_id'] == null ? undefined : json['run_id'],
+        'threadId': json['thread_id'] == null ? undefined : json['thread_id'],
+        'messageId': json['message_id'] == null ? undefined : json['message_id'],
+        'userId': json['user_id'],
+        'startedAt': (json['started_at'] == null ? null : new Date(json['started_at'])),
+        'endedAt': json['ended_at'] == null ? undefined : (new Date(json['ended_at'])),
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'model': json['model'] == null ? undefined : json['model'],
+        'generations': json['generations'] == null ? undefined : json['generations'],
+        'toolCalls': json['tool_calls'] == null ? undefined : json['tool_calls'],
+        'subagents': json['subagents'] == null ? undefined : json['subagents'],
+        'inputTokens': json['input_tokens'] == null ? undefined : json['input_tokens'],
+        'outputTokens': json['output_tokens'] == null ? undefined : json['output_tokens'],
+        'cachedTokens': json['cached_tokens'] == null ? undefined : json['cached_tokens'],
+        'reasoningTokens': json['reasoning_tokens'] == null ? undefined : json['reasoning_tokens'],
+        'maxContext': json['max_context'] == null ? undefined : json['max_context'],
+        'degenerateGens': json['degenerate_gens'] == null ? undefined : json['degenerate_gens'],
+        'selfDoubtPer1k': json['self_doubt_per_1k'] == null ? undefined : json['self_doubt_per_1k'],
+        'cacheRate': json['cache_rate'] == null ? undefined : json['cache_rate'],
+        'reasoningShare': json['reasoning_share'] == null ? undefined : json['reasoning_share'],
+        'singleToolRate': json['single_tool_rate'] == null ? undefined : json['single_tool_rate'],
+        'nEvents': json['n_events'] == null ? undefined : json['n_events'],
+        'metrics': json['metrics'] == null ? undefined : json['metrics'],
+        'traceComplete': json['trace_complete'] == null ? undefined : json['trace_complete'],
+        'corruptResults': json['corrupt_results'] == null ? undefined : json['corrupt_results'],
+        'backendVersion': json['backend_version'] == null ? undefined : json['backend_version'],
+        'schemaVersion': json['schema_version'] == null ? undefined : json['schema_version'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'path': json['path'] == null ? undefined : json['path'],
+        'workflowId': json['workflow_id'] == null ? undefined : json['workflow_id'],
+        'workflowName': json['workflow_name'] == null ? undefined : json['workflow_name'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'runLabel': json['run_label'] == null ? undefined : json['run_label'],
+        'traceUrl': json['trace_url'] == null ? undefined : json['trace_url'],
+        'expiresInSeconds': json['expires_in_seconds'] == null ? undefined : json['expires_in_seconds'],
+    };
+}
+function DiagnosticTraceItemToJSON(json) {
+    return DiagnosticTraceItemToJSONTyped(json, false);
+}
+function DiagnosticTraceItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': (0, DiagnosticTraceStatus_1.DiagnosticTraceStatusToJSON)(value['status']),
+        'kind': (0, TraceKind_1.TraceKindToJSON)(value['kind']),
+        'reason': (0, DiagnosticTraceFailureReason_1.DiagnosticTraceFailureReasonToJSON)(value['reason']),
+        'trace_id': value['traceId'],
+        'run_id': value['runId'],
+        'thread_id': value['threadId'],
+        'message_id': value['messageId'],
+        'user_id': value['userId'],
+        'started_at': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'ended_at': value['endedAt'] == null ? value['endedAt'] : value['endedAt'].toISOString(),
+        'duration_ms': value['durationMs'],
+        'model': value['model'],
+        'generations': value['generations'],
+        'tool_calls': value['toolCalls'],
+        'subagents': value['subagents'],
+        'input_tokens': value['inputTokens'],
+        'output_tokens': value['outputTokens'],
+        'cached_tokens': value['cachedTokens'],
+        'reasoning_tokens': value['reasoningTokens'],
+        'max_context': value['maxContext'],
+        'degenerate_gens': value['degenerateGens'],
+        'self_doubt_per_1k': value['selfDoubtPer1k'],
+        'cache_rate': value['cacheRate'],
+        'reasoning_share': value['reasoningShare'],
+        'single_tool_rate': value['singleToolRate'],
+        'n_events': value['nEvents'],
+        'metrics': value['metrics'],
+        'trace_complete': value['traceComplete'],
+        'corrupt_results': value['corruptResults'],
+        'backend_version': value['backendVersion'],
+        'schema_version': value['schemaVersion'],
+        'title': value['title'],
+        'path': value['path'],
+        'workflow_id': value['workflowId'],
+        'workflow_name': value['workflowName'],
+        'state': value['state'],
+        'run_label': value['runLabel'],
+        'trace_url': value['traceUrl'],
+        'expires_in_seconds': value['expiresInSeconds'],
+    };
+}

package/dist/models/DiagnosticTraceStatus.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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
+ */
+export declare const DiagnosticTraceStatus: {
+    readonly Ready: 'ready';
+    readonly Pending: 'pending';
+    readonly Failed: 'failed';
+};
+export type DiagnosticTraceStatus = typeof DiagnosticTraceStatus[keyof typeof DiagnosticTraceStatus];
+export declare function instanceOfDiagnosticTraceStatus(value: any): boolean;
+export declare function DiagnosticTraceStatusFromJSON(json: any): DiagnosticTraceStatus;
+export declare function DiagnosticTraceStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiagnosticTraceStatus;
+export declare function DiagnosticTraceStatusToJSON(value?: DiagnosticTraceStatus | null): any;
+export declare function DiagnosticTraceStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): DiagnosticTraceStatus;

package/dist/models/DiagnosticTraceStatus.js

@@ -0,0 +1,52 @@
+"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.DiagnosticTraceStatus = void 0;
+exports.instanceOfDiagnosticTraceStatus = instanceOfDiagnosticTraceStatus;
+exports.DiagnosticTraceStatusFromJSON = DiagnosticTraceStatusFromJSON;
+exports.DiagnosticTraceStatusFromJSONTyped = DiagnosticTraceStatusFromJSONTyped;
+exports.DiagnosticTraceStatusToJSON = DiagnosticTraceStatusToJSON;
+exports.DiagnosticTraceStatusToJSONTyped = DiagnosticTraceStatusToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.DiagnosticTraceStatus = {
+    Ready: 'ready',
+    Pending: 'pending',
+    Failed: 'failed'
+};
+function instanceOfDiagnosticTraceStatus(value) {
+    for (const key in exports.DiagnosticTraceStatus) {
+        if (Object.prototype.hasOwnProperty.call(exports.DiagnosticTraceStatus, key)) {
+            if (exports.DiagnosticTraceStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function DiagnosticTraceStatusFromJSON(json) {
+    return DiagnosticTraceStatusFromJSONTyped(json, false);
+}
+function DiagnosticTraceStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function DiagnosticTraceStatusToJSON(value) {
+    return value;
+}
+function DiagnosticTraceStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/DiagnosticsResponse.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 { DiagnosticTraceItem } from './DiagnosticTraceItem';
+/**
+ *
+ * @export
+ * @interface DiagnosticsResponse
+ */
+export interface DiagnosticsResponse {
+    /**
+     * True when no item is pending.
+     * @type {boolean}
+     * @memberof DiagnosticsResponse
+     */
+    _final: boolean;
+    /**
+     *
+     * @type {Array<DiagnosticTraceItem>}
+     * @memberof DiagnosticsResponse
+     */
+    traces: Array<DiagnosticTraceItem>;
+}
+export declare const DiagnosticsResponsePropertyValidationAttributesMap: {
+    [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 DiagnosticsResponse interface.
+ */
+export declare function instanceOfDiagnosticsResponse(value: object): value is DiagnosticsResponse;
+export declare function DiagnosticsResponseFromJSON(json: any): DiagnosticsResponse;
+export declare function DiagnosticsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiagnosticsResponse;
+export declare function DiagnosticsResponseToJSON(json: any): DiagnosticsResponse;
+export declare function DiagnosticsResponseToJSONTyped(value?: DiagnosticsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DiagnosticsResponse.js

@@ -0,0 +1,57 @@
+"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.DiagnosticsResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfDiagnosticsResponse = instanceOfDiagnosticsResponse;
+exports.DiagnosticsResponseFromJSON = DiagnosticsResponseFromJSON;
+exports.DiagnosticsResponseFromJSONTyped = DiagnosticsResponseFromJSONTyped;
+exports.DiagnosticsResponseToJSON = DiagnosticsResponseToJSON;
+exports.DiagnosticsResponseToJSONTyped = DiagnosticsResponseToJSONTyped;
+const DiagnosticTraceItem_1 = require("./DiagnosticTraceItem");
+exports.DiagnosticsResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DiagnosticsResponse interface.
+ */
+function instanceOfDiagnosticsResponse(value) {
+    if (!('_final' in value) || value['_final'] === undefined)
+        return false;
+    if (!('traces' in value) || value['traces'] === undefined)
+        return false;
+    return true;
+}
+function DiagnosticsResponseFromJSON(json) {
+    return DiagnosticsResponseFromJSONTyped(json, false);
+}
+function DiagnosticsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        '_final': json['final'],
+        'traces': (json['traces'].map(DiagnosticTraceItem_1.DiagnosticTraceItemFromJSON)),
+    };
+}
+function DiagnosticsResponseToJSON(json) {
+    return DiagnosticsResponseToJSONTyped(json, false);
+}
+function DiagnosticsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'final': value['_final'],
+        'traces': (value['traces'].map(DiagnosticTraceItem_1.DiagnosticTraceItemToJSON)),
+    };
+}

package/dist/models/TraceKind.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+export declare const TraceKind: {
+    readonly WorkflowRun: 'workflow_run';
+    readonly ChatTurn: 'chat_turn';
+};
+export type TraceKind = typeof TraceKind[keyof typeof TraceKind];
+export declare function instanceOfTraceKind(value: any): boolean;
+export declare function TraceKindFromJSON(json: any): TraceKind;
+export declare function TraceKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): TraceKind;
+export declare function TraceKindToJSON(value?: TraceKind | null): any;
+export declare function TraceKindToJSONTyped(value: any, ignoreDiscriminator: boolean): TraceKind;

package/dist/models/TraceKind.js

@@ -0,0 +1,51 @@
+"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.TraceKind = void 0;
+exports.instanceOfTraceKind = instanceOfTraceKind;
+exports.TraceKindFromJSON = TraceKindFromJSON;
+exports.TraceKindFromJSONTyped = TraceKindFromJSONTyped;
+exports.TraceKindToJSON = TraceKindToJSON;
+exports.TraceKindToJSONTyped = TraceKindToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.TraceKind = {
+    WorkflowRun: 'workflow_run',
+    ChatTurn: 'chat_turn'
+};
+function instanceOfTraceKind(value) {
+    for (const key in exports.TraceKind) {
+        if (Object.prototype.hasOwnProperty.call(exports.TraceKind, key)) {
+            if (exports.TraceKind[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function TraceKindFromJSON(json) {
+    return TraceKindFromJSONTyped(json, false);
+}
+function TraceKindFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function TraceKindToJSON(value) {
+    return value;
+}
+function TraceKindToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -102,6 +102,10 @@ export * from './DataSourceSchemaResponse';
 export * from './DataSourceSyncResponse';
 export * from './DataSourceTableResponse';
 export * from './DefinitionOutputStat';
+export * from './DiagnosticTraceFailureReason';
+export * from './DiagnosticTraceItem';
+export * from './DiagnosticTraceStatus';
+export * from './DiagnosticsResponse';
 export * from './DiffFormat';
 export * from './DiffRow';
 export * from './DiffRowType';
@@ -335,6 +339,7 @@ export * from './TimeseriesPoint';
 export * from './ToolDisplayType';
 export * from './ToolPart';
 export * from './ToolStatus';
+export * from './TraceKind';
 export * from './TranscriptionResponse';
 export * from './TransferOwnerRequest';
 export * from './TransferOwnerResponse';

package/dist/models/index.js

@@ -120,6 +120,10 @@ __exportStar(require("./DataSourceSchemaResponse"), exports);
 __exportStar(require("./DataSourceSyncResponse"), exports);
 __exportStar(require("./DataSourceTableResponse"), exports);
 __exportStar(require("./DefinitionOutputStat"), exports);
+__exportStar(require("./DiagnosticTraceFailureReason"), exports);
+__exportStar(require("./DiagnosticTraceItem"), exports);
+__exportStar(require("./DiagnosticTraceStatus"), exports);
+__exportStar(require("./DiagnosticsResponse"), exports);
 __exportStar(require("./DiffFormat"), exports);
 __exportStar(require("./DiffRow"), exports);
 __exportStar(require("./DiffRowType"), exports);
@@ -353,6 +357,7 @@ __exportStar(require("./TimeseriesPoint"), exports);
 __exportStar(require("./ToolDisplayType"), exports);
 __exportStar(require("./ToolPart"), exports);
 __exportStar(require("./ToolStatus"), exports);
+__exportStar(require("./TraceKind"), exports);
 __exportStar(require("./TranscriptionResponse"), exports);
 __exportStar(require("./TransferOwnerRequest"), exports);
 __exportStar(require("./TransferOwnerResponse"), exports);

package/docs/DiagnosticTraceFailureReason.md

@@ -0,0 +1,32 @@
+
+# DiagnosticTraceFailureReason
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DiagnosticTraceFailureReason } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DiagnosticTraceFailureReason
+
+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 DiagnosticTraceFailureReason
+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/DiagnosticTraceItem.md

@@ -0,0 +1,111 @@
+
+# DiagnosticTraceItem
+
+One trace of the conversation; stats and the link are null unless ready.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [DiagnosticTraceStatus](DiagnosticTraceStatus.md)
+`kind` | [TraceKind](TraceKind.md)
+`reason` | [DiagnosticTraceFailureReason](DiagnosticTraceFailureReason.md)
+`traceId` | string
+`runId` | string
+`threadId` | string
+`messageId` | string
+`userId` | string
+`startedAt` | Date
+`endedAt` | Date
+`durationMs` | number
+`model` | string
+`generations` | number
+`toolCalls` | number
+`subagents` | number
+`inputTokens` | number
+`outputTokens` | number
+`cachedTokens` | number
+`reasoningTokens` | number
+`maxContext` | number
+`degenerateGens` | number
+`selfDoubtPer1k` | number
+`cacheRate` | number
+`reasoningShare` | number
+`singleToolRate` | number
+`nEvents` | number
+`metrics` | { [key: string]: any; }
+`traceComplete` | boolean
+`corruptResults` | boolean
+`backendVersion` | string
+`schemaVersion` | number
+`title` | string
+`path` | string
+`workflowId` | string
+`workflowName` | string
+`state` | string
+`runLabel` | string
+`traceUrl` | string
+`expiresInSeconds` | number
+
+## Example
+
+```typescript
+import type { DiagnosticTraceItem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "kind": null,
+  "reason": null,
+  "traceId": null,
+  "runId": null,
+  "threadId": null,
+  "messageId": null,
+  "userId": null,
+  "startedAt": null,
+  "endedAt": null,
+  "durationMs": null,
+  "model": null,
+  "generations": null,
+  "toolCalls": null,
+  "subagents": null,
+  "inputTokens": null,
+  "outputTokens": null,
+  "cachedTokens": null,
+  "reasoningTokens": null,
+  "maxContext": null,
+  "degenerateGens": null,
+  "selfDoubtPer1k": null,
+  "cacheRate": null,
+  "reasoningShare": null,
+  "singleToolRate": null,
+  "nEvents": null,
+  "metrics": null,
+  "traceComplete": null,
+  "corruptResults": null,
+  "backendVersion": null,
+  "schemaVersion": null,
+  "title": null,
+  "path": null,
+  "workflowId": null,
+  "workflowName": null,
+  "state": null,
+  "runLabel": null,
+  "traceUrl": null,
+  "expiresInSeconds": null,
+} satisfies DiagnosticTraceItem
+
+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 DiagnosticTraceItem
+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/DiagnosticTraceStatus.md

@@ -0,0 +1,32 @@
+
+# DiagnosticTraceStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DiagnosticTraceStatus } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DiagnosticTraceStatus
+
+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 DiagnosticTraceStatus
+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)
+
+