@knowledge-stack/ksapi 3.16.1 → 3.17.0

package/src/models/RepoCommitSummary.ts

@@ -0,0 +1,119 @@
+/* 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 RepoCommitSummary
+ */
+export interface RepoCommitSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoCommitSummary
+     */
+    sha: string;
+    /**
+     * First line of the commit message.
+     * @type {string}
+     * @memberof RepoCommitSummary
+     */
+    subject: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RepoCommitSummary
+     */
+    authoredAt: Date;
+    /**
+     * The run saving this repository snapshot.
+     * @type {string}
+     * @memberof RepoCommitSummary
+     */
+    runId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoCommitSummary
+     */
+    savedByUserId: string;
+}
+export const RepoCommitSummaryPropertyValidationAttributesMap: {
+    [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 RepoCommitSummary interface.
+ */
+export function instanceOfRepoCommitSummary(value: object): value is RepoCommitSummary {
+    if (!('sha' in value) || value['sha'] === undefined) return false;
+    if (!('subject' in value) || value['subject'] === undefined) return false;
+    if (!('authoredAt' in value) || value['authoredAt'] === undefined) return false;
+    if (!('runId' in value) || value['runId'] === undefined) return false;
+    if (!('savedByUserId' in value) || value['savedByUserId'] === undefined) return false;
+    return true;
+}
+
+export function RepoCommitSummaryFromJSON(json: any): RepoCommitSummary {
+    return RepoCommitSummaryFromJSONTyped(json, false);
+}
+
+export function RepoCommitSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoCommitSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sha': json['sha'],
+        'subject': json['subject'],
+        'authoredAt': (new Date(json['authored_at'])),
+        'runId': json['run_id'],
+        'savedByUserId': json['saved_by_user_id'],
+    };
+}
+
+export function RepoCommitSummaryToJSON(json: any): RepoCommitSummary {
+    return RepoCommitSummaryToJSONTyped(json, false);
+}
+
+export function RepoCommitSummaryToJSONTyped(value?: RepoCommitSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sha': value['sha'],
+        'subject': value['subject'],
+        'authored_at': value['authoredAt'].toISOString(),
+        'run_id': value['runId'],
+        'saved_by_user_id': value['savedByUserId'],
+    };
+}
+

package/src/models/RepoSaveSkipReason.ts

@@ -0,0 +1,64 @@
+/* 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.
+ */
+
+
+/**
+ * Why retention or integration could not complete.
+ * 
+ * ``conflict``: integration failed; a retained branch remains recoverable.
+ * ``history_rewrite``:
+ * the run rewrote saved history. ``no_write``: the turn's user cannot write the
+ * workflow. ``uncommitted``: changes were never committed to the assigned branch.
+ * ``rejected``: the platform refused the bundle (too large, unsafe paths).
+ * ``failed``: the checkout or the save itself failed.
+ * @export
+ */
+export const RepoSaveSkipReason = {
+    Conflict: 'conflict',
+    HistoryRewrite: 'history_rewrite',
+    NoWrite: 'no_write',
+    Uncommitted: 'uncommitted',
+    Rejected: 'rejected',
+    Failed: 'failed'
+} as const;
+export type RepoSaveSkipReason = typeof RepoSaveSkipReason[keyof typeof RepoSaveSkipReason];
+
+
+export function instanceOfRepoSaveSkipReason(value: any): boolean {
+    for (const key in RepoSaveSkipReason) {
+        if (Object.prototype.hasOwnProperty.call(RepoSaveSkipReason, key)) {
+            if (RepoSaveSkipReason[key as keyof typeof RepoSaveSkipReason] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function RepoSaveSkipReasonFromJSON(json: any): RepoSaveSkipReason {
+    return RepoSaveSkipReasonFromJSONTyped(json, false);
+}
+
+export function RepoSaveSkipReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoSaveSkipReason {
+    return json as RepoSaveSkipReason;
+}
+
+export function RepoSaveSkipReasonToJSON(value?: RepoSaveSkipReason | null): any {
+    return value as any;
+}
+
+export function RepoSaveSkipReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): RepoSaveSkipReason {
+    return value as RepoSaveSkipReason;
+}
+

package/src/models/RepoSnapshot.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * The workflow repository version a run was started against.
+ * @export
+ * @interface RepoSnapshot
+ */
+export interface RepoSnapshot {
+    /**
+     * Commit id of main the run checks out
+     * @type {string}
+     * @memberof RepoSnapshot
+     */
+    commit: string;
+    /**
+     * DocumentVersion holding that main's bundle
+     * @type {string}
+     * @memberof RepoSnapshot
+     */
+    versionId: string;
+    /**
+     * Instruction version (DOCUMENT_VERSION path_part) that repository version was saved against; the runner compares it with this run's pinned instruction.
+     * @type {string}
+     * @memberof RepoSnapshot
+     */
+    instructionVersionId?: string | null;
+}
+export const RepoSnapshotPropertyValidationAttributesMap: {
+    [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 RepoSnapshot interface.
+ */
+export function instanceOfRepoSnapshot(value: object): value is RepoSnapshot {
+    if (!('commit' in value) || value['commit'] === undefined) return false;
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    return true;
+}
+
+export function RepoSnapshotFromJSON(json: any): RepoSnapshot {
+    return RepoSnapshotFromJSONTyped(json, false);
+}
+
+export function RepoSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'commit': json['commit'],
+        'versionId': json['version_id'],
+        'instructionVersionId': json['instruction_version_id'] == null ? undefined : json['instruction_version_id'],
+    };
+}
+
+export function RepoSnapshotToJSON(json: any): RepoSnapshot {
+    return RepoSnapshotToJSONTyped(json, false);
+}
+
+export function RepoSnapshotToJSONTyped(value?: RepoSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'commit': value['commit'],
+        'version_id': value['versionId'],
+        'instruction_version_id': value['instructionVersionId'],
+    };
+}
+

package/src/models/RepoTreeEntry.ts

@@ -0,0 +1,101 @@
+/* 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 RepoTreeEntry
+ */
+export interface RepoTreeEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoTreeEntry
+     */
+    path: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RepoTreeEntry
+     */
+    size: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RepoTreeEntry
+     */
+    isBinary: boolean;
+}
+export const RepoTreeEntryPropertyValidationAttributesMap: {
+    [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 RepoTreeEntry interface.
+ */
+export function instanceOfRepoTreeEntry(value: object): value is RepoTreeEntry {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('size' in value) || value['size'] === undefined) return false;
+    if (!('isBinary' in value) || value['isBinary'] === undefined) return false;
+    return true;
+}
+
+export function RepoTreeEntryFromJSON(json: any): RepoTreeEntry {
+    return RepoTreeEntryFromJSONTyped(json, false);
+}
+
+export function RepoTreeEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoTreeEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'size': json['size'],
+        'isBinary': json['is_binary'],
+    };
+}
+
+export function RepoTreeEntryToJSON(json: any): RepoTreeEntry {
+    return RepoTreeEntryToJSONTyped(json, false);
+}
+
+export function RepoTreeEntryToJSONTyped(value?: RepoTreeEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'size': value['size'],
+        'is_binary': value['isBinary'],
+    };
+}
+

package/src/models/RepoTreeResponse.ts

@@ -0,0 +1,100 @@
+/* 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';
+import type { RepoTreeEntry } from './RepoTreeEntry';
+import {
+    RepoTreeEntryFromJSON,
+    RepoTreeEntryFromJSONTyped,
+    RepoTreeEntryToJSON,
+    RepoTreeEntryToJSONTyped,
+} from './RepoTreeEntry';
+
+/**
+ * 
+ * @export
+ * @interface RepoTreeResponse
+ */
+export interface RepoTreeResponse {
+    /**
+     * Null when the repository does not exist.
+     * @type {string}
+     * @memberof RepoTreeResponse
+     */
+    commit: string | null;
+    /**
+     * Every file, path-sorted.
+     * @type {Array<RepoTreeEntry>}
+     * @memberof RepoTreeResponse
+     */
+    entries: Array<RepoTreeEntry>;
+}
+export const RepoTreeResponsePropertyValidationAttributesMap: {
+    [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 RepoTreeResponse interface.
+ */
+export function instanceOfRepoTreeResponse(value: object): value is RepoTreeResponse {
+    if (!('commit' in value) || value['commit'] === undefined) return false;
+    if (!('entries' in value) || value['entries'] === undefined) return false;
+    return true;
+}
+
+export function RepoTreeResponseFromJSON(json: any): RepoTreeResponse {
+    return RepoTreeResponseFromJSONTyped(json, false);
+}
+
+export function RepoTreeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoTreeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'commit': json['commit'],
+        'entries': ((json['entries'] as Array<any>).map(RepoTreeEntryFromJSON)),
+    };
+}
+
+export function RepoTreeResponseToJSON(json: any): RepoTreeResponse {
+    return RepoTreeResponseToJSONTyped(json, false);
+}
+
+export function RepoTreeResponseToJSONTyped(value?: RepoTreeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'commit': value['commit'],
+        'entries': ((value['entries'] as Array<any>).map(RepoTreeEntryToJSON)),
+    };
+}
+

package/src/models/RepoVersionResponse.ts

@@ -0,0 +1,154 @@
+/* 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';
+/**
+ * One saved version: a new main and the run that saved it.
+ * @export
+ * @interface RepoVersionResponse
+ */
+export interface RepoVersionResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    versionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    headSha: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    previousHeadSha: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof RepoVersionResponse
+     */
+    commitsAdded: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    runId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    savedByUserId: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RepoVersionResponse
+     */
+    savedAt: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    instructionVersionId: string | null;
+    /**
+     * Retained run-branch version this publication integrated.
+     * @type {string}
+     * @memberof RepoVersionResponse
+     */
+    candidateVersionId?: string | null;
+}
+export const RepoVersionResponsePropertyValidationAttributesMap: {
+    [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 RepoVersionResponse interface.
+ */
+export function instanceOfRepoVersionResponse(value: object): value is RepoVersionResponse {
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    if (!('headSha' in value) || value['headSha'] === undefined) return false;
+    if (!('previousHeadSha' in value) || value['previousHeadSha'] === undefined) return false;
+    if (!('commitsAdded' in value) || value['commitsAdded'] === undefined) return false;
+    if (!('runId' in value) || value['runId'] === undefined) return false;
+    if (!('savedByUserId' in value) || value['savedByUserId'] === undefined) return false;
+    if (!('savedAt' in value) || value['savedAt'] === undefined) return false;
+    if (!('instructionVersionId' in value) || value['instructionVersionId'] === undefined) return false;
+    return true;
+}
+
+export function RepoVersionResponseFromJSON(json: any): RepoVersionResponse {
+    return RepoVersionResponseFromJSONTyped(json, false);
+}
+
+export function RepoVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepoVersionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'versionId': json['version_id'],
+        'headSha': json['head_sha'],
+        'previousHeadSha': json['previous_head_sha'],
+        'commitsAdded': json['commits_added'],
+        'runId': json['run_id'],
+        'savedByUserId': json['saved_by_user_id'],
+        'savedAt': (new Date(json['saved_at'])),
+        'instructionVersionId': json['instruction_version_id'],
+        'candidateVersionId': json['candidate_version_id'] == null ? undefined : json['candidate_version_id'],
+    };
+}
+
+export function RepoVersionResponseToJSON(json: any): RepoVersionResponse {
+    return RepoVersionResponseToJSONTyped(json, false);
+}
+
+export function RepoVersionResponseToJSONTyped(value?: RepoVersionResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'version_id': value['versionId'],
+        'head_sha': value['headSha'],
+        'previous_head_sha': value['previousHeadSha'],
+        'commits_added': value['commitsAdded'],
+        'run_id': value['runId'],
+        'saved_by_user_id': value['savedByUserId'],
+        'saved_at': value['savedAt'].toISOString(),
+        'instruction_version_id': value['instructionVersionId'],
+        'candidate_version_id': value['candidateVersionId'],
+    };
+}
+