@knowledge-stack/ksapi 1.156.0 → 1.157.0

package/.openapi-generator/FILES

@@ -295,6 +295,7 @@ docs/SectionContentItemOrChunkContentItem.md
 docs/SectionResponse.md
 docs/SectionSystemMetadata.md
 docs/SectionsApi.md
+docs/SegmentSpan.md
 docs/SendPasswordResetRequest.md
 docs/SetApprovalStateRequest.md
 docs/SetWorkflowRunApprovalRequest.md
@@ -733,6 +734,7 @@ src/models/SectionContentItem.ts
 src/models/SectionContentItemOrChunkContentItem.ts
 src/models/SectionResponse.ts
 src/models/SectionSystemMetadata.ts
+src/models/SegmentSpan.ts
 src/models/SendPasswordResetRequest.ts
 src/models/SetApprovalStateRequest.ts
 src/models/SetWorkflowRunApprovalRequest.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.156.0
+# @knowledge-stack/ksapi@1.157.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -569,6 +569,7 @@ All URIs are relative to *http://localhost:8000*
 - [SectionContentItemOrChunkContentItem](docs/SectionContentItemOrChunkContentItem.md)
 - [SectionResponse](docs/SectionResponse.md)
 - [SectionSystemMetadata](docs/SectionSystemMetadata.md)
+- [SegmentSpan](docs/SegmentSpan.md)
 - [SendPasswordResetRequest](docs/SendPasswordResetRequest.md)
 - [SetApprovalStateRequest](docs/SetApprovalStateRequest.md)
 - [SetWorkflowRunApprovalRequest](docs/SetWorkflowRunApprovalRequest.md)
@@ -708,7 +709,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.156.0`
+- Package version: `1.157.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/DocumentVersionsApi.d.ts

@@ -182,7 +182,7 @@ export interface DocumentVersionsApiInterface {
     /**
      * Creates request options for downloadDocumentVersion without sending the request
      * @param {string} versionId DocumentVersion ID
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @throws {RequiredError}
      * @memberof DocumentVersionsApiInterface
      */
@@ -191,7 +191,7 @@ export interface DocumentVersionsApiInterface {
      * Issue a short-lived, audited download link for a specific version.  Records a ``document.downloaded`` audit event anchored to the document so the customer audit log captures who downloaded which version and when.
      * @summary Download Document Version Handler
      * @param {string} versionId DocumentVersion ID
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentVersionsApiInterface

package/dist/apis/DocumentsApi.d.ts

@@ -204,7 +204,7 @@ export interface DocumentsApiInterface {
     /**
      * Creates request options for downloadDocument without sending the request
      * @param {string} documentId
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
      */
@@ -213,7 +213,7 @@ export interface DocumentsApiInterface {
      * Issue a short-lived, audited download link for a document\'s active version.  Records a ``document.downloaded`` audit event so the customer audit log captures who downloaded which document/version and when.
      * @summary Download Document Handler
      * @param {string} documentId
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -182,7 +182,7 @@ export interface DocumentVersionsApiInterface {
     /**
      * Creates request options for downloadDocumentVersion without sending the request
      * @param {string} versionId DocumentVersion ID
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @throws {RequiredError}
      * @memberof DocumentVersionsApiInterface
      */
@@ -191,7 +191,7 @@ export interface DocumentVersionsApiInterface {
      * Issue a short-lived, audited download link for a specific version.  Records a ``document.downloaded`` audit event anchored to the document so the customer audit log captures who downloaded which version and when.
      * @summary Download Document Version Handler
      * @param {string} versionId DocumentVersion ID
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentVersionsApiInterface

package/dist/esm/apis/DocumentsApi.d.ts

@@ -204,7 +204,7 @@ export interface DocumentsApiInterface {
     /**
      * Creates request options for downloadDocument without sending the request
      * @param {string} documentId
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
      */
@@ -213,7 +213,7 @@ export interface DocumentsApiInterface {
      * Issue a short-lived, audited download link for a document\'s active version.  Records a ``document.downloaded`` audit event so the customer audit log captures who downloaded which document/version and when.
      * @summary Download Document Handler
      * @param {string} documentId
-     * @param {DownloadArtifact} [artifact] Artifact to download: source or fast_plaintext
+     * @param {DownloadArtifact} [artifact] Artifact to download: source, fast_plaintext, or transcript (media only)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SegmentSpan } from './SegmentSpan';
 import type { ImageTaxonomy } from './ImageTaxonomy';
 import type { PolygonReference } from './PolygonReference';
 /**
@@ -65,6 +66,12 @@ export interface ChunkMetadata {
      * @memberof ChunkMetadata
      */
     endMs?: number | null;
+    /**
+     * Per-ASR-segment spans inside this media chunk, in order, each carrying its char offset in the chunk content. Lets citation resolution narrow a chunk-level timeframe to the enclosing segment. None for non-media chunks and media ingested before this field existed.
+     * @type {Array<SegmentSpan>}
+     * @memberof ChunkMetadata
+     */
+    segments?: Array<SegmentSpan> | null;
     /**
      * Worksheet name this chunk was extracted from (XLSX only)
      * @type {string}

package/dist/esm/models/ChunkMetadata.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SegmentSpanFromJSON, SegmentSpanToJSON, } from './SegmentSpan';
 import { ImageTaxonomyFromJSON, ImageTaxonomyToJSON, } from './ImageTaxonomy';
 import { PolygonReferenceFromJSON, PolygonReferenceToJSON, } from './PolygonReference';
 export const ChunkMetadataPropertyValidationAttributesMap = {};
@@ -36,6 +37,7 @@ export function ChunkMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
         'startMs': json['start_ms'] == null ? undefined : json['start_ms'],
         'endMs': json['end_ms'] == null ? undefined : json['end_ms'],
+        'segments': json['segments'] == null ? undefined : (json['segments'].map(SegmentSpanFromJSON)),
         'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
         'blockType': json['block_type'] == null ? undefined : json['block_type'],
         'sourceUri': json['source_uri'] == null ? undefined : json['source_uri'],
@@ -63,6 +65,7 @@ export function ChunkMetadataToJSONTyped(value, ignoreDiscriminator = false) {
         'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
         'start_ms': value['startMs'],
         'end_ms': value['endMs'],
+        'segments': value['segments'] == null ? undefined : (value['segments'].map(SegmentSpanToJSON)),
         'sheet_name': value['sheetName'],
         'block_type': value['blockType'],
         'source_uri': value['sourceUri'],

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

@@ -57,6 +57,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     fastPlaintextS3?: string | null;
+    /**
+     * S3 URI of the ASR transcript JSON (per-segment start_ms/end_ms/text); null for non-media. Chunks carry timings too, but at merged-chunk granularity, so this is the only per-segment source.
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    transcriptS3?: string | null;
     /**
      * Base64-encoded SHA256 hash of the uploaded source file
      * @type {string}
@@ -157,6 +163,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     quotaPageCount?: number;
+    /**
+     * MEDIA_MINUTE quantity charged at media preparation; 0 if not yet charged
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    quotaMediaMinutes?: number;
     /**
      * Stable consume key (matches workflow_id); 'UNSET' for pre-Phase-2 docs so refund logic short-circuits
      * @type {string}

package/dist/esm/models/DocumentVersionMetadata.js

@@ -34,6 +34,7 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
         'preconversionSourceS3': json['preconversion_source_s3'] == null ? undefined : json['preconversion_source_s3'],
         'citedSourceS3': json['cited_source_s3'] == null ? undefined : json['cited_source_s3'],
         'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
+        'transcriptS3': json['transcript_s3'] == null ? undefined : json['transcript_s3'],
         'hash': json['hash'] == null ? undefined : json['hash'],
         'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
@@ -50,6 +51,7 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
         'informationStatistics': json['information_statistics'] == null ? undefined : InformationStatisticsFromJSON(json['information_statistics']),
         'quotaCharged': json['quota_charged'] == null ? undefined : json['quota_charged'],
         'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
+        'quotaMediaMinutes': json['quota_media_minutes'] == null ? undefined : json['quota_media_minutes'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
         'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
@@ -68,6 +70,7 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
         'preconversion_source_s3': value['preconversionSourceS3'],
         'cited_source_s3': value['citedSourceS3'],
         'fast_plaintext_s3': value['fastPlaintextS3'],
+        'transcript_s3': value['transcriptS3'],
         'hash': value['hash'],
         'pipeline_state': PipelineStateToJSON(value['pipelineState']),
         'total_pages': value['totalPages'],
@@ -84,6 +87,7 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
         'information_statistics': InformationStatisticsToJSON(value['informationStatistics']),
         'quota_charged': value['quotaCharged'],
         'quota_page_count': value['quotaPageCount'],
+        'quota_media_minutes': value['quotaMediaMinutes'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
         'idempotency_key': value['idempotencyKey'],

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

@@ -57,6 +57,12 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     fastPlaintextS3?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    transcriptS3?: string | null;
     /**
      *
      * @type {string}
@@ -169,6 +175,12 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     quotaPageCount?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    quotaMediaMinutes?: number | null;
     /**
      *
      * @type {string}

package/dist/esm/models/DocumentVersionMetadataUpdate.js

@@ -35,6 +35,7 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscrimin
         'citedSourceS3': json['cited_source_s3'] == null ? undefined : json['cited_source_s3'],
         'standardPipelineJsonS3': json['standard_pipeline_json_s3'] == null ? undefined : json['standard_pipeline_json_s3'],
         'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
+        'transcriptS3': json['transcript_s3'] == null ? undefined : json['transcript_s3'],
         'highAccuracyContentListS3': json['high_accuracy_content_list_s3'] == null ? undefined : json['high_accuracy_content_list_s3'],
         'highAccuracyMiddleS3': json['high_accuracy_middle_s3'] == null ? undefined : json['high_accuracy_middle_s3'],
         'hash': json['hash'] == null ? undefined : json['hash'],
@@ -53,6 +54,7 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscrimin
         'informationStatistics': json['information_statistics'] == null ? undefined : InformationStatisticsFromJSON(json['information_statistics']),
         'quotaCharged': json['quota_charged'] == null ? undefined : json['quota_charged'],
         'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
+        'quotaMediaMinutes': json['quota_media_minutes'] == null ? undefined : json['quota_media_minutes'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
     };
@@ -71,6 +73,7 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscrimina
         'cited_source_s3': value['citedSourceS3'],
         'standard_pipeline_json_s3': value['standardPipelineJsonS3'],
         'fast_plaintext_s3': value['fastPlaintextS3'],
+        'transcript_s3': value['transcriptS3'],
         'high_accuracy_content_list_s3': value['highAccuracyContentListS3'],
         'high_accuracy_middle_s3': value['highAccuracyMiddleS3'],
         'hash': value['hash'],
@@ -89,6 +92,7 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscrimina
         'information_statistics': InformationStatisticsToJSON(value['informationStatistics']),
         'quota_charged': value['quotaCharged'],
         'quota_page_count': value['quotaPageCount'],
+        'quota_media_minutes': value['quotaMediaMinutes'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
     };

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

@@ -104,6 +104,12 @@ export interface DocumentVersionResponse {
      * @memberof DocumentVersionResponse
      */
     fastPlaintextUrl?: string | null;
+    /**
+     * Presigned URL (6-hour validity) to the ASR transcript JSON with per-segment start_ms/end_ms/text; null for non-media. Chunks pack many segments into one, so this is what a client reads to follow a recording line by line.
+     * @type {string}
+     * @memberof DocumentVersionResponse
+     */
+    transcriptUrl?: string | null;
     /**
      * Presigned URLs (6-hour validity) to per-page WEBP screenshots in page order: index 0 is page 1, index N-1 is page N. Populated only when the request includes include_page_screenshots=true; null otherwise.
      * @type {Array<string>}

package/dist/esm/models/DocumentVersionResponse.js

@@ -64,6 +64,7 @@ export function DocumentVersionResponseFromJSONTyped(json, ignoreDiscriminator)
         'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
         'citedAssetS3Url': json['cited_asset_s3_url'] == null ? undefined : json['cited_asset_s3_url'],
         'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
+        'transcriptUrl': json['transcript_url'] == null ? undefined : json['transcript_url'],
         'pageScreenshotUrls': json['page_screenshot_urls'] == null ? undefined : json['page_screenshot_urls'],
         'systemMetadata': json['system_metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['system_metadata']),
     };
@@ -90,6 +91,7 @@ export function DocumentVersionResponseToJSONTyped(value, ignoreDiscriminator =
         'asset_s3_url': value['assetS3Url'],
         'cited_asset_s3_url': value['citedAssetS3Url'],
         'fast_plaintext_url': value['fastPlaintextUrl'],
+        'transcript_url': value['transcriptUrl'],
         'page_screenshot_urls': value['pageScreenshotUrls'],
         'system_metadata': DocumentVersionMetadataToJSON(value['systemMetadata']),
     };

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

@@ -16,6 +16,7 @@
 export declare const DownloadArtifact: {
     readonly Source: 'source';
     readonly FastPlaintext: 'fast_plaintext';
+    readonly Transcript: 'transcript';
 };
 export type DownloadArtifact = typeof DownloadArtifact[keyof typeof DownloadArtifact];
 export declare function instanceOfDownloadArtifact(value: any): boolean;

package/dist/esm/models/DownloadArtifact.js

@@ -17,7 +17,8 @@
  */
 export const DownloadArtifact = {
     Source: 'source',
-    FastPlaintext: 'fast_plaintext'
+    FastPlaintext: 'fast_plaintext',
+    Transcript: 'transcript'
 };
 export function instanceOfDownloadArtifact(value) {
     for (const key in DownloadArtifact) {

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

@@ -0,0 +1,62 @@
+/**
+ * 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 ASR segment's span inside a media chunk (media chunks only).
+ *
+ * Field names are deliberately compact — a media document stores hundreds
+ * of chunks x up to ~15 spans each in ``chunk_metadata`` JSONB.
+ * @export
+ * @interface SegmentSpan
+ */
+export interface SegmentSpan {
+    /**
+     * Segment start in the media, ms from start.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    s: number;
+    /**
+     * Segment end in the media, ms from start.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    e: number;
+    /**
+     * Character offset of this segment's text within the chunk's joined content — maps a position in the chunk text back to a moment in the recording.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    c: number;
+}
+export declare const SegmentSpanPropertyValidationAttributesMap: {
+    [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 SegmentSpan interface.
+ */
+export declare function instanceOfSegmentSpan(value: object): value is SegmentSpan;
+export declare function SegmentSpanFromJSON(json: any): SegmentSpan;
+export declare function SegmentSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentSpan;
+export declare function SegmentSpanToJSON(json: any): SegmentSpan;
+export declare function SegmentSpanToJSONTyped(value?: SegmentSpan | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SegmentSpan.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 SegmentSpanPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SegmentSpan interface.
+ */
+export function instanceOfSegmentSpan(value) {
+    if (!('s' in value) || value['s'] === undefined)
+        return false;
+    if (!('e' in value) || value['e'] === undefined)
+        return false;
+    if (!('c' in value) || value['c'] === undefined)
+        return false;
+    return true;
+}
+export function SegmentSpanFromJSON(json) {
+    return SegmentSpanFromJSONTyped(json, false);
+}
+export function SegmentSpanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        's': json['s'],
+        'e': json['e'],
+        'c': json['c'],
+    };
+}
+export function SegmentSpanToJSON(json) {
+    return SegmentSpanToJSONTyped(json, false);
+}
+export function SegmentSpanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        's': value['s'],
+        'e': value['e'],
+        'c': value['c'],
+    };
+}

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

@@ -34,6 +34,18 @@ export interface UploadConstraints {
      * @memberof UploadConstraints
      */
     maxImageBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UploadConstraints
+     */
+    maxMediaBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UploadConstraints
+     */
+    maxVideoBytes: number;
 }
 export declare const UploadConstraintsPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/UploadConstraints.js

@@ -23,6 +23,10 @@ export function instanceOfUploadConstraints(value) {
         return false;
     if (!('maxImageBytes' in value) || value['maxImageBytes'] === undefined)
         return false;
+    if (!('maxMediaBytes' in value) || value['maxMediaBytes'] === undefined)
+        return false;
+    if (!('maxVideoBytes' in value) || value['maxVideoBytes'] === undefined)
+        return false;
     return true;
 }
 export function UploadConstraintsFromJSON(json) {
@@ -36,6 +40,8 @@ export function UploadConstraintsFromJSONTyped(json, ignoreDiscriminator) {
         'formats': (json['formats'].map(UploadFormatFromJSON)),
         'maxBytes': json['max_bytes'],
         'maxImageBytes': json['max_image_bytes'],
+        'maxMediaBytes': json['max_media_bytes'],
+        'maxVideoBytes': json['max_video_bytes'],
     };
 }
 export function UploadConstraintsToJSON(json) {
@@ -49,5 +55,7 @@ export function UploadConstraintsToJSONTyped(value, ignoreDiscriminator = false)
         'formats': (value['formats'].map(UploadFormatToJSON)),
         'max_bytes': value['maxBytes'],
         'max_image_bytes': value['maxImageBytes'],
+        'max_media_bytes': value['maxMediaBytes'],
+        'max_video_bytes': value['maxVideoBytes'],
     };
 }

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

@@ -265,6 +265,7 @@ export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
 export * from './SectionSystemMetadata';
+export * from './SegmentSpan';
 export * from './SendPasswordResetRequest';
 export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';

package/dist/esm/models/index.js

@@ -267,6 +267,7 @@ export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
 export * from './SectionSystemMetadata';
+export * from './SegmentSpan';
 export * from './SendPasswordResetRequest';
 export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';

package/dist/models/ChunkMetadata.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SegmentSpan } from './SegmentSpan';
 import type { ImageTaxonomy } from './ImageTaxonomy';
 import type { PolygonReference } from './PolygonReference';
 /**
@@ -65,6 +66,12 @@ export interface ChunkMetadata {
      * @memberof ChunkMetadata
      */
     endMs?: number | null;
+    /**
+     * Per-ASR-segment spans inside this media chunk, in order, each carrying its char offset in the chunk content. Lets citation resolution narrow a chunk-level timeframe to the enclosing segment. None for non-media chunks and media ingested before this field existed.
+     * @type {Array<SegmentSpan>}
+     * @memberof ChunkMetadata
+     */
+    segments?: Array<SegmentSpan> | null;
     /**
      * Worksheet name this chunk was extracted from (XLSX only)
      * @type {string}

package/dist/models/ChunkMetadata.js

@@ -19,6 +19,7 @@ exports.ChunkMetadataFromJSON = ChunkMetadataFromJSON;
 exports.ChunkMetadataFromJSONTyped = ChunkMetadataFromJSONTyped;
 exports.ChunkMetadataToJSON = ChunkMetadataToJSON;
 exports.ChunkMetadataToJSONTyped = ChunkMetadataToJSONTyped;
+const SegmentSpan_1 = require("./SegmentSpan");
 const ImageTaxonomy_1 = require("./ImageTaxonomy");
 const PolygonReference_1 = require("./PolygonReference");
 exports.ChunkMetadataPropertyValidationAttributesMap = {};
@@ -44,6 +45,7 @@ function ChunkMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : (0, ImageTaxonomy_1.ImageTaxonomyFromJSON)(json['secondary_taxonomy']),
         'startMs': json['start_ms'] == null ? undefined : json['start_ms'],
         'endMs': json['end_ms'] == null ? undefined : json['end_ms'],
+        'segments': json['segments'] == null ? undefined : (json['segments'].map(SegmentSpan_1.SegmentSpanFromJSON)),
         'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
         'blockType': json['block_type'] == null ? undefined : json['block_type'],
         'sourceUri': json['source_uri'] == null ? undefined : json['source_uri'],
@@ -71,6 +73,7 @@ function ChunkMetadataToJSONTyped(value, ignoreDiscriminator = false) {
         'secondary_taxonomy': (0, ImageTaxonomy_1.ImageTaxonomyToJSON)(value['secondaryTaxonomy']),
         'start_ms': value['startMs'],
         'end_ms': value['endMs'],
+        'segments': value['segments'] == null ? undefined : (value['segments'].map(SegmentSpan_1.SegmentSpanToJSON)),
         'sheet_name': value['sheetName'],
         'block_type': value['blockType'],
         'source_uri': value['sourceUri'],

package/dist/models/DocumentVersionMetadata.d.ts

@@ -57,6 +57,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     fastPlaintextS3?: string | null;
+    /**
+     * S3 URI of the ASR transcript JSON (per-segment start_ms/end_ms/text); null for non-media. Chunks carry timings too, but at merged-chunk granularity, so this is the only per-segment source.
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    transcriptS3?: string | null;
     /**
      * Base64-encoded SHA256 hash of the uploaded source file
      * @type {string}
@@ -157,6 +163,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     quotaPageCount?: number;
+    /**
+     * MEDIA_MINUTE quantity charged at media preparation; 0 if not yet charged
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    quotaMediaMinutes?: number;
     /**
      * Stable consume key (matches workflow_id); 'UNSET' for pre-Phase-2 docs so refund logic short-circuits
      * @type {string}

package/dist/models/DocumentVersionMetadata.js

@@ -42,6 +42,7 @@ function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'preconversionSourceS3': json['preconversion_source_s3'] == null ? undefined : json['preconversion_source_s3'],
         'citedSourceS3': json['cited_source_s3'] == null ? undefined : json['cited_source_s3'],
         'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
+        'transcriptS3': json['transcript_s3'] == null ? undefined : json['transcript_s3'],
         'hash': json['hash'] == null ? undefined : json['hash'],
         'pipelineState': json['pipeline_state'] == null ? undefined : (0, PipelineState_1.PipelineStateFromJSON)(json['pipeline_state']),
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
@@ -58,6 +59,7 @@ function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'informationStatistics': json['information_statistics'] == null ? undefined : (0, InformationStatistics_1.InformationStatisticsFromJSON)(json['information_statistics']),
         'quotaCharged': json['quota_charged'] == null ? undefined : json['quota_charged'],
         'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
+        'quotaMediaMinutes': json['quota_media_minutes'] == null ? undefined : json['quota_media_minutes'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
         'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
@@ -76,6 +78,7 @@ function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator = false)
         'preconversion_source_s3': value['preconversionSourceS3'],
         'cited_source_s3': value['citedSourceS3'],
         'fast_plaintext_s3': value['fastPlaintextS3'],
+        'transcript_s3': value['transcriptS3'],
         'hash': value['hash'],
         'pipeline_state': (0, PipelineState_1.PipelineStateToJSON)(value['pipelineState']),
         'total_pages': value['totalPages'],
@@ -92,6 +95,7 @@ function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator = false)
         'information_statistics': (0, InformationStatistics_1.InformationStatisticsToJSON)(value['informationStatistics']),
         'quota_charged': value['quotaCharged'],
         'quota_page_count': value['quotaPageCount'],
+        'quota_media_minutes': value['quotaMediaMinutes'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
         'idempotency_key': value['idempotencyKey'],