@aignostics/sdk 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,7 +5,7 @@ import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
5
5
  * Aignostics Platform API
6
6
  * The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
7
7
  *
8
- * The version of the OpenAPI document: 1.0.0-beta.7
8
+ * The version of the OpenAPI document: 1.0.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -97,7 +97,7 @@ declare class Configuration {
97
97
  * Aignostics Platform API
98
98
  * The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
99
99
  *
100
- * The version of the OpenAPI document: 1.0.0-beta.7
100
+ * The version of the OpenAPI document: 1.0.1
101
101
  *
102
102
  *
103
103
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -273,6 +273,19 @@ interface CustomMetadataUpdateRequest {
273
273
  */
274
274
  'custom_metadata_checksum'?: string | null;
275
275
  }
276
+ /**
277
+ *
278
+ * @export
279
+ * @interface CustomMetadataUpdateResponse
280
+ */
281
+ interface CustomMetadataUpdateResponse {
282
+ /**
283
+ *
284
+ * @type {string}
285
+ * @memberof CustomMetadataUpdateResponse
286
+ */
287
+ 'custom_metadata_checksum': string | null;
288
+ }
276
289
  /**
277
290
  *
278
291
  * @export
@@ -401,6 +414,18 @@ interface ItemResultReadResponse {
401
414
  * @memberof ItemResultReadResponse
402
415
  */
403
416
  'custom_metadata_checksum'?: string | null;
417
+ /**
418
+ *
419
+ * @type {number}
420
+ * @memberof ItemResultReadResponse
421
+ */
422
+ 'queue_position_org'?: number | null;
423
+ /**
424
+ *
425
+ * @type {number}
426
+ * @memberof ItemResultReadResponse
427
+ */
428
+ 'queue_position_platform'?: number | null;
404
429
  /**
405
430
  * The item moves from `PENDING` to `PROCESSING` to `TERMINATED` state. When terminated, consult the `termination_reason` property to see whether it was successful.
406
431
  * @type {ItemState}
@@ -859,6 +884,18 @@ interface RunReadResponse {
859
884
  * @memberof RunReadResponse
860
885
  */
861
886
  'terminated_at'?: string | null;
887
+ /**
888
+ *
889
+ * @type {number}
890
+ * @memberof RunReadResponse
891
+ */
892
+ 'num_preceding_items_org'?: number | null;
893
+ /**
894
+ *
895
+ * @type {number}
896
+ * @memberof RunReadResponse
897
+ */
898
+ 'num_preceding_items_platform'?: number | null;
862
899
  }
863
900
  /**
864
901
  *
@@ -1018,7 +1055,7 @@ interface VersionReadResponse {
1018
1055
  */
1019
1056
  declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1020
1057
  /**
1021
- * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
1058
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1022
1059
  * @summary Application Version Details
1023
1060
  * @param {string} applicationId
1024
1061
  * @param {string} version
@@ -1027,7 +1064,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1027
1064
  */
1028
1065
  applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1029
1066
  /**
1030
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1067
+ * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1031
1068
  * @summary Cancel Run
1032
1069
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1033
1070
  * @param {*} [options] Override http request option.
@@ -1035,7 +1072,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1035
1072
  */
1036
1073
  cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1037
1074
  /**
1038
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1075
+ * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1039
1076
  * @summary Initiate Run
1040
1077
  * @param {RunCreationRequest} runCreationRequest
1041
1078
  * @param {*} [options] Override http request option.
@@ -1043,7 +1080,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1043
1080
  */
1044
1081
  createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1045
1082
  /**
1046
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
1083
+ * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1047
1084
  * @summary Delete Run Items
1048
1085
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1049
1086
  * @param {*} [options] Override http request option.
@@ -1067,15 +1104,15 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1067
1104
  */
1068
1105
  getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1069
1106
  /**
1070
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1107
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1071
1108
  * @summary Get run details
1072
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1109
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1073
1110
  * @param {*} [options] Override http request option.
1074
1111
  * @throws {RequiredError}
1075
1112
  */
1076
1113
  getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1077
1114
  /**
1078
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
1115
+ * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1079
1116
  * @summary List available applications
1080
1117
  * @param {number} [page]
1081
1118
  * @param {number} [pageSize]
@@ -1085,9 +1122,9 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1085
1122
  */
1086
1123
  listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1087
1124
  /**
1088
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1125
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1089
1126
  * @summary List Run Items
1090
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1127
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1091
1128
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
1092
1129
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1093
1130
  * @param {ItemState | null} [state] Filter items by their state
@@ -1095,7 +1132,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1095
1132
  * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1096
1133
  * @param {number} [page]
1097
1134
  * @param {number} [pageSize]
1098
- * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;run_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1135
+ * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1099
1136
  * @param {*} [options] Override http request option.
1100
1137
  * @throws {RequiredError}
1101
1138
  */
@@ -1106,16 +1143,16 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1106
1143
  * @param {string | null} [applicationId] Optional application ID filter
1107
1144
  * @param {string | null} [applicationVersion] Optional Version Name
1108
1145
  * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1109
- * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
1146
+ * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
1110
1147
  * @param {number} [page]
1111
1148
  * @param {number} [pageSize]
1112
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_version_id&#x60; - &#x60;organization_id&#x60; - &#x60;status&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;status&amp;sort&#x3D;-submitted_at&#x60; - Sort by status, then by time (descending)
1149
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
1113
1150
  * @param {*} [options] Override http request option.
1114
1151
  * @throws {RequiredError}
1115
1152
  */
1116
1153
  listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1117
1154
  /**
1118
- *
1155
+ * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1119
1156
  * @summary Put Item Custom Metadata By Run
1120
1157
  * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1121
1158
  * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
@@ -1125,7 +1162,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1125
1162
  */
1126
1163
  putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: (runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1127
1164
  /**
1128
- *
1165
+ * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1129
1166
  * @summary Put Run Custom Metadata
1130
1167
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1131
1168
  * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
@@ -1148,7 +1185,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1148
1185
  */
1149
1186
  declare const PublicApiFp: (configuration?: Configuration) => {
1150
1187
  /**
1151
- * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
1188
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1152
1189
  * @summary Application Version Details
1153
1190
  * @param {string} applicationId
1154
1191
  * @param {string} version
@@ -1157,7 +1194,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1157
1194
  */
1158
1195
  applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionReadResponse>>;
1159
1196
  /**
1160
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1197
+ * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1161
1198
  * @summary Cancel Run
1162
1199
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1163
1200
  * @param {*} [options] Override http request option.
@@ -1165,7 +1202,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1165
1202
  */
1166
1203
  cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1167
1204
  /**
1168
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1205
+ * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1169
1206
  * @summary Initiate Run
1170
1207
  * @param {RunCreationRequest} runCreationRequest
1171
1208
  * @param {*} [options] Override http request option.
@@ -1173,7 +1210,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1173
1210
  */
1174
1211
  createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
1175
1212
  /**
1176
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
1213
+ * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1177
1214
  * @summary Delete Run Items
1178
1215
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1179
1216
  * @param {*} [options] Override http request option.
@@ -1197,15 +1234,15 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1197
1234
  */
1198
1235
  getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
1199
1236
  /**
1200
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1237
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1201
1238
  * @summary Get run details
1202
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1239
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1203
1240
  * @param {*} [options] Override http request option.
1204
1241
  * @throws {RequiredError}
1205
1242
  */
1206
1243
  getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
1207
1244
  /**
1208
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
1245
+ * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1209
1246
  * @summary List available applications
1210
1247
  * @param {number} [page]
1211
1248
  * @param {number} [pageSize]
@@ -1215,9 +1252,9 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1215
1252
  */
1216
1253
  listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
1217
1254
  /**
1218
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1255
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1219
1256
  * @summary List Run Items
1220
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1257
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1221
1258
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
1222
1259
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1223
1260
  * @param {ItemState | null} [state] Filter items by their state
@@ -1225,7 +1262,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1225
1262
  * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1226
1263
  * @param {number} [page]
1227
1264
  * @param {number} [pageSize]
1228
- * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;run_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1265
+ * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1229
1266
  * @param {*} [options] Override http request option.
1230
1267
  * @throws {RequiredError}
1231
1268
  */
@@ -1236,16 +1273,16 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1236
1273
  * @param {string | null} [applicationId] Optional application ID filter
1237
1274
  * @param {string | null} [applicationVersion] Optional Version Name
1238
1275
  * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1239
- * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
1276
+ * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
1240
1277
  * @param {number} [page]
1241
1278
  * @param {number} [pageSize]
1242
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_version_id&#x60; - &#x60;organization_id&#x60; - &#x60;status&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;status&amp;sort&#x3D;-submitted_at&#x60; - Sort by status, then by time (descending)
1279
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
1243
1280
  * @param {*} [options] Override http request option.
1244
1281
  * @throws {RequiredError}
1245
1282
  */
1246
1283
  listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
1247
1284
  /**
1248
- *
1285
+ * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1249
1286
  * @summary Put Item Custom Metadata By Run
1250
1287
  * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1251
1288
  * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
@@ -1253,16 +1290,16 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1253
1290
  * @param {*} [options] Override http request option.
1254
1291
  * @throws {RequiredError}
1255
1292
  */
1256
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1293
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1257
1294
  /**
1258
- *
1295
+ * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1259
1296
  * @summary Put Run Custom Metadata
1260
1297
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1261
1298
  * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1262
1299
  * @param {*} [options] Override http request option.
1263
1300
  * @throws {RequiredError}
1264
1301
  */
1265
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1302
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1266
1303
  /**
1267
1304
  * Retrieve details of a specific application by its ID.
1268
1305
  * @summary Read Application By Id
@@ -1278,7 +1315,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
1278
1315
  */
1279
1316
  declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1280
1317
  /**
1281
- * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
1318
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1282
1319
  * @summary Application Version Details
1283
1320
  * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1284
1321
  * @param {*} [options] Override http request option.
@@ -1286,7 +1323,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1286
1323
  */
1287
1324
  applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
1288
1325
  /**
1289
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1326
+ * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1290
1327
  * @summary Cancel Run
1291
1328
  * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1292
1329
  * @param {*} [options] Override http request option.
@@ -1294,7 +1331,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1294
1331
  */
1295
1332
  cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1296
1333
  /**
1297
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1334
+ * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1298
1335
  * @summary Initiate Run
1299
1336
  * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1300
1337
  * @param {*} [options] Override http request option.
@@ -1302,7 +1339,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1302
1339
  */
1303
1340
  createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1304
1341
  /**
1305
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
1342
+ * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1306
1343
  * @summary Delete Run Items
1307
1344
  * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1308
1345
  * @param {*} [options] Override http request option.
@@ -1325,7 +1362,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1325
1362
  */
1326
1363
  getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1327
1364
  /**
1328
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1365
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1329
1366
  * @summary Get run details
1330
1367
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1331
1368
  * @param {*} [options] Override http request option.
@@ -1333,7 +1370,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1333
1370
  */
1334
1371
  getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1335
1372
  /**
1336
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
1373
+ * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1337
1374
  * @summary List available applications
1338
1375
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1339
1376
  * @param {*} [options] Override http request option.
@@ -1341,7 +1378,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1341
1378
  */
1342
1379
  listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
1343
1380
  /**
1344
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1381
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1345
1382
  * @summary List Run Items
1346
1383
  * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1347
1384
  * @param {*} [options] Override http request option.
@@ -1357,21 +1394,21 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1357
1394
  */
1358
1395
  listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1359
1396
  /**
1360
- *
1397
+ * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1361
1398
  * @summary Put Item Custom Metadata By Run
1362
1399
  * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1363
1400
  * @param {*} [options] Override http request option.
1364
1401
  * @throws {RequiredError}
1365
1402
  */
1366
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1403
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1367
1404
  /**
1368
- *
1405
+ * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1369
1406
  * @summary Put Run Custom Metadata
1370
1407
  * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1371
1408
  * @param {*} [options] Override http request option.
1372
1409
  * @throws {RequiredError}
1373
1410
  */
1374
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1411
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1375
1412
  /**
1376
1413
  * Retrieve details of a specific application by its ID.
1377
1414
  * @summary Read Application By Id
@@ -1388,7 +1425,7 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
1388
1425
  */
1389
1426
  interface PublicApiInterface {
1390
1427
  /**
1391
- * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
1428
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1392
1429
  * @summary Application Version Details
1393
1430
  * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1394
1431
  * @param {*} [options] Override http request option.
@@ -1397,7 +1434,7 @@ interface PublicApiInterface {
1397
1434
  */
1398
1435
  applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
1399
1436
  /**
1400
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1437
+ * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1401
1438
  * @summary Cancel Run
1402
1439
  * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1403
1440
  * @param {*} [options] Override http request option.
@@ -1406,7 +1443,7 @@ interface PublicApiInterface {
1406
1443
  */
1407
1444
  cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1408
1445
  /**
1409
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1446
+ * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1410
1447
  * @summary Initiate Run
1411
1448
  * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1412
1449
  * @param {*} [options] Override http request option.
@@ -1415,7 +1452,7 @@ interface PublicApiInterface {
1415
1452
  */
1416
1453
  createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1417
1454
  /**
1418
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
1455
+ * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1419
1456
  * @summary Delete Run Items
1420
1457
  * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1421
1458
  * @param {*} [options] Override http request option.
@@ -1441,7 +1478,7 @@ interface PublicApiInterface {
1441
1478
  */
1442
1479
  getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1443
1480
  /**
1444
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1481
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1445
1482
  * @summary Get run details
1446
1483
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1447
1484
  * @param {*} [options] Override http request option.
@@ -1450,7 +1487,7 @@ interface PublicApiInterface {
1450
1487
  */
1451
1488
  getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1452
1489
  /**
1453
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
1490
+ * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1454
1491
  * @summary List available applications
1455
1492
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1456
1493
  * @param {*} [options] Override http request option.
@@ -1459,7 +1496,7 @@ interface PublicApiInterface {
1459
1496
  */
1460
1497
  listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
1461
1498
  /**
1462
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1499
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1463
1500
  * @summary List Run Items
1464
1501
  * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1465
1502
  * @param {*} [options] Override http request option.
@@ -1477,23 +1514,23 @@ interface PublicApiInterface {
1477
1514
  */
1478
1515
  listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1479
1516
  /**
1480
- *
1517
+ * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1481
1518
  * @summary Put Item Custom Metadata By Run
1482
1519
  * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1483
1520
  * @param {*} [options] Override http request option.
1484
1521
  * @throws {RequiredError}
1485
1522
  * @memberof PublicApiInterface
1486
1523
  */
1487
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1524
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1488
1525
  /**
1489
- *
1526
+ * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1490
1527
  * @summary Put Run Custom Metadata
1491
1528
  * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1492
1529
  * @param {*} [options] Override http request option.
1493
1530
  * @throws {RequiredError}
1494
1531
  * @memberof PublicApiInterface
1495
1532
  */
1496
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1533
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1497
1534
  /**
1498
1535
  * Retrieve details of a specific application by its ID.
1499
1536
  * @summary Read Application By Id
@@ -1588,7 +1625,7 @@ interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
1588
1625
  */
1589
1626
  interface PublicApiGetRunV1RunsRunIdGetRequest {
1590
1627
  /**
1591
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
1628
+ * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1592
1629
  * @type {string}
1593
1630
  * @memberof PublicApiGetRunV1RunsRunIdGet
1594
1631
  */
@@ -1626,7 +1663,7 @@ interface PublicApiListApplicationsV1ApplicationsGetRequest {
1626
1663
  */
1627
1664
  interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
1628
1665
  /**
1629
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
1666
+ * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1630
1667
  * @type {string}
1631
1668
  * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1632
1669
  */
@@ -1674,7 +1711,7 @@ interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
1674
1711
  */
1675
1712
  readonly pageSize?: number;
1676
1713
  /**
1677
- * Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;run_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1714
+ * Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1678
1715
  * @type {Array<string>}
1679
1716
  * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1680
1717
  */
@@ -1705,7 +1742,7 @@ interface PublicApiListRunsV1RunsGetRequest {
1705
1742
  */
1706
1743
  readonly externalId?: string | null;
1707
1744
  /**
1708
- * Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
1745
+ * Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
1709
1746
  * @type {string}
1710
1747
  * @memberof PublicApiListRunsV1RunsGet
1711
1748
  */
@@ -1723,7 +1760,7 @@ interface PublicApiListRunsV1RunsGetRequest {
1723
1760
  */
1724
1761
  readonly pageSize?: number;
1725
1762
  /**
1726
- * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_version_id&#x60; - &#x60;organization_id&#x60; - &#x60;status&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;status&amp;sort&#x3D;-submitted_at&#x60; - Sort by status, then by time (descending)
1763
+ * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
1727
1764
  * @type {Array<string>}
1728
1765
  * @memberof PublicApiListRunsV1RunsGet
1729
1766
  */
@@ -1794,7 +1831,7 @@ interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
1794
1831
  */
1795
1832
  declare class PublicApi extends BaseAPI implements PublicApiInterface {
1796
1833
  /**
1797
- * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
1834
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1798
1835
  * @summary Application Version Details
1799
1836
  * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1800
1837
  * @param {*} [options] Override http request option.
@@ -1803,7 +1840,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1803
1840
  */
1804
1841
  applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionReadResponse, any, {}>>;
1805
1842
  /**
1806
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1843
+ * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1807
1844
  * @summary Cancel Run
1808
1845
  * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1809
1846
  * @param {*} [options] Override http request option.
@@ -1812,7 +1849,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1812
1849
  */
1813
1850
  cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
1814
1851
  /**
1815
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1852
+ * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1816
1853
  * @summary Initiate Run
1817
1854
  * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1818
1855
  * @param {*} [options] Override http request option.
@@ -1821,7 +1858,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1821
1858
  */
1822
1859
  createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
1823
1860
  /**
1824
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
1861
+ * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1825
1862
  * @summary Delete Run Items
1826
1863
  * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1827
1864
  * @param {*} [options] Override http request option.
@@ -1847,7 +1884,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1847
1884
  */
1848
1885
  getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
1849
1886
  /**
1850
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1887
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
1851
1888
  * @summary Get run details
1852
1889
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1853
1890
  * @param {*} [options] Override http request option.
@@ -1856,7 +1893,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1856
1893
  */
1857
1894
  getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
1858
1895
  /**
1859
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
1896
+ * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1860
1897
  * @summary List available applications
1861
1898
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1862
1899
  * @param {*} [options] Override http request option.
@@ -1865,7 +1902,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1865
1902
  */
1866
1903
  listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
1867
1904
  /**
1868
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1905
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1869
1906
  * @summary List Run Items
1870
1907
  * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1871
1908
  * @param {*} [options] Override http request option.
@@ -1883,23 +1920,23 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1883
1920
  */
1884
1921
  listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
1885
1922
  /**
1886
- *
1923
+ * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1887
1924
  * @summary Put Item Custom Metadata By Run
1888
1925
  * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1889
1926
  * @param {*} [options] Override http request option.
1890
1927
  * @throws {RequiredError}
1891
1928
  * @memberof PublicApi
1892
1929
  */
1893
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
1930
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
1894
1931
  /**
1895
- *
1932
+ * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1896
1933
  * @summary Put Run Custom Metadata
1897
1934
  * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1898
1935
  * @param {*} [options] Override http request option.
1899
1936
  * @throws {RequiredError}
1900
1937
  * @memberof PublicApi
1901
1938
  */
1902
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
1939
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
1903
1940
  /**
1904
1941
  * Retrieve details of a specific application by its ID.
1905
1942
  * @summary Read Application By Id
@@ -1911,4 +1948,4 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1911
1948
  readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
1912
1949
  }
1913
1950
 
1914
- export { type ApplicationReadShortResponse as A, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as B, type CustomMetadataUpdateRequest as C, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as D, type PublicApiCreateRunV1RunsPostRequest as E, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as F, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiGetRunV1RunsRunIdGetRequest as J, type PublicApiListApplicationsV1ApplicationsGetRequest as K, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as L, type MeReadResponse as M, type PublicApiListRunsV1RunsGetRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as Q, type RunReadResponse as R, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as S, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as T, type UserReadResponse as U, type ValidationError as V, PublicApi as W, type ConfigurationParameters as X, Configuration as Y, type ApplicationReadResponse as a, type RunCreationRequest as b, type RunCreationResponse as c, type ApplicationVersion as d, ArtifactOutput as e, ArtifactState as f, ArtifactTerminationReason as g, type InputArtifact as h, type InputArtifactCreationRequest as i, type ItemCreationRequest as j, ItemOutput as k, ItemState as l, ItemTerminationReason as m, type OutputArtifact as n, type OutputArtifactResultReadResponse as o, OutputArtifactScope as p, OutputArtifactVisibility as q, type RunItemStatistics as r, RunOutput as s, RunState as t, RunTerminationReason as u, type ValidationErrorLocInner as v, type VersionReadResponse as w, PublicApiFp as x, PublicApiFactory as y, type PublicApiInterface as z };
1951
+ export { type ApplicationReadShortResponse as A, type PublicApiInterface as B, type CustomMetadataUpdateRequest as C, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as D, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as E, type PublicApiCreateRunV1RunsPostRequest as F, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as J, type PublicApiGetRunV1RunsRunIdGetRequest as K, type PublicApiListApplicationsV1ApplicationsGetRequest as L, type MeReadResponse as M, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiListRunsV1RunsGetRequest as Q, type RunReadResponse as R, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as S, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as T, type UserReadResponse as U, type VersionReadResponse as V, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as W, PublicApi as X, type ConfigurationParameters as Y, Configuration as Z, type ApplicationReadResponse as a, type RunCreationRequest as b, type RunCreationResponse as c, type ApplicationVersion as d, ArtifactOutput as e, ArtifactState as f, ArtifactTerminationReason as g, type CustomMetadataUpdateResponse as h, type InputArtifact as i, type InputArtifactCreationRequest as j, type ItemCreationRequest as k, ItemOutput as l, ItemState as m, ItemTerminationReason as n, type OutputArtifact as o, type OutputArtifactResultReadResponse as p, OutputArtifactScope as q, OutputArtifactVisibility as r, type RunItemStatistics as s, RunOutput as t, RunState as u, RunTerminationReason as v, type ValidationError as w, type ValidationErrorLocInner as x, PublicApiFp as y, PublicApiFactory as z };