@thinkai/tai-api-contract 2.174.0 → 2.175.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.173.0
+  version: 2.175.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -96,7 +96,8 @@ tags:
     description: >
       Workspace prompt/model eval suites (`/evals/*`) — authored golden cases with
       deterministic expected-signal scoring, async runs (never scored on the request
-      path), and an Insights surface for regressions and token efficiency. Distinct
+      path), an Insights surface for regressions and token efficiency, and platform
+      starter packs (`/evals/packs`) that install as editable suites. Distinct
       from AI Usage & Spend ingest and Agentic Foundation Token Efficiency (rubric I).
 
 paths:
@@ -11998,6 +11999,95 @@ paths:
         "403":
           $ref: "#/components/responses/Forbidden"
 
+  /workspaces/{workspaceId}/evals/packs:
+    get:
+      tags: [Evals]
+      summary: List platform eval starter packs
+      description: >
+        Returns the platform starter-pack catalog for Prompt & model evals.
+        Packs are ThinkAI-authored templates (not workspace-owned and not a
+        public marketplace). Requires workspace membership. Empty catalog is
+        not expected in production builds; clients should still handle
+        `{ "packs": [] }`.
+      operationId: listEvalPacks
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      responses:
+        "200":
+          description: Starter pack catalog
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EvalPackListDto"
+              example:
+                packs:
+                  - id: pr-review
+                    name: PR review comments
+                    description: Check review tone and clear blocking feedback
+                    workflow: pr-review
+                    caseCount: 3
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          description: Workspace not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
+  /workspaces/{workspaceId}/evals/packs/{packId}/install:
+    post:
+      tags: [Evals]
+      summary: Install an eval starter pack as a suite
+      description: >
+        Creates a new editable eval suite from a platform starter pack
+        (`version: 1`). Sets `target.promptKey` to `pack:<packId>` for
+        traceability. Requires workspace editor or admin. Pack cases include
+        fixture completions so the first run can succeed without AI connectors.
+        Does not score on the request path.
+      operationId: installEvalPack
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+        - $ref: "#/components/parameters/EvalPackId"
+      responses:
+        "201":
+          description: Suite created from pack
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EvalSuiteDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          description: Viewer cannot install packs
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+              example:
+                error: Workspace editor role required
+                code: workspace_editor_required
+        "404":
+          description: Unknown pack id or workspace not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+              example:
+                error: Eval starter pack not found
+                code: eval_pack_not_found
+        "409":
+          description: Workspace already has the maximum number of suites (50)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+              example:
+                error: Maximum of 50 eval suites per workspace
+                code: eval_suite_limit_reached
+
   /workspaces/{workspaceId}/evals/suites:
     get:
       tags: [Evals]
@@ -12365,6 +12455,17 @@ components:
         type: string
         format: uuid
       description: Eval suite id (`tai_workspace_eval_suites.id`).
+    EvalPackId:
+      name: packId
+      in: path
+      required: true
+      schema:
+        type: string
+        minLength: 1
+        maxLength: 64
+        pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+      description: >
+        Platform starter pack id (kebab-case), e.g. `pr-review`. Not a UUID.
     EvalRunId:
       name: runId
       in: path
@@ -26510,3 +26611,45 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/EvalModelComparisonDto"
+
+    EvalPackSummaryDto:
+      type: object
+      additionalProperties: false
+      required: [id, name, description, workflow, caseCount]
+      description: >
+        Platform starter pack summary for the hub catalog. Install materializes a
+        full `EvalSuiteDto`; pack payloads are not returned on list.
+      properties:
+        id:
+          type: string
+          minLength: 1
+          maxLength: 64
+          pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+          description: Stable pack id (kebab-case).
+        name:
+          type: string
+          minLength: 1
+          maxLength: 120
+        description:
+          type: string
+          maxLength: 2000
+        workflow:
+          type: string
+          minLength: 1
+          maxLength: 64
+          description: Workflow bucket for UI grouping (e.g. `pr-review`).
+        caseCount:
+          type: integer
+          minimum: 1
+          maximum: 20
+          description: Number of golden cases that will be created on install.
+
+    EvalPackListDto:
+      type: object
+      additionalProperties: false
+      required: [packs]
+      properties:
+        packs:
+          type: array
+          items:
+            $ref: "#/components/schemas/EvalPackSummaryDto"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.174.0",
+  "version": "2.175.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",

package/src/generated/openapi.ts

@@ -4806,6 +4806,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/workspaces/{workspaceId}/evals/packs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List platform eval starter packs
+         * @description Returns the platform starter-pack catalog for Prompt & model evals. Packs are ThinkAI-authored templates (not workspace-owned and not a public marketplace). Requires workspace membership. Empty catalog is not expected in production builds; clients should still handle `{ "packs": [] }`.
+         */
+        get: operations["listEvalPacks"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/evals/packs/{packId}/install": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Install an eval starter pack as a suite
+         * @description Creates a new editable eval suite from a platform starter pack (`version: 1`). Sets `target.promptKey` to `pack:<packId>` for traceability. Requires workspace editor or admin. Pack cases include fixture completions so the first run can succeed without AI connectors. Does not score on the request path.
+         */
+        post: operations["installEvalPack"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/evals/suites": {
         parameters: {
             query?: never;
@@ -11388,6 +11428,20 @@ export interface components {
             tokenEfficiency: components["schemas"]["EvalTokenEfficiencyDto"] | null;
             modelComparison: components["schemas"]["EvalModelComparisonDto"][];
         };
+        /** @description Platform starter pack summary for the hub catalog. Install materializes a full `EvalSuiteDto`; pack payloads are not returned on list. */
+        EvalPackSummaryDto: {
+            /** @description Stable pack id (kebab-case). */
+            id: string;
+            name: string;
+            description: string;
+            /** @description Workflow bucket for UI grouping (e.g. `pr-review`). */
+            workflow: string;
+            /** @description Number of golden cases that will be created on install. */
+            caseCount: number;
+        };
+        EvalPackListDto: {
+            packs: components["schemas"]["EvalPackSummaryDto"][];
+        };
     };
     responses: {
         /** @description Missing or invalid bearer token */
@@ -11427,6 +11481,8 @@ export interface components {
         WorkspaceId: string;
         /** @description Eval suite id (`tai_workspace_eval_suites.id`). */
         EvalSuiteId: string;
+        /** @description Platform starter pack id (kebab-case), e.g. `pr-review`. Not a UUID. */
+        EvalPackId: string;
         /** @description Eval run id (`tai_workspace_eval_runs.id`). */
         EvalRunId: string;
         RepoId: string;
@@ -12102,11 +12158,14 @@ export type EvalPromptTipDto = components['schemas']['EvalPromptTipDto'];
 export type EvalTokenEfficiencyDto = components['schemas']['EvalTokenEfficiencyDto'];
 export type EvalModelComparisonDto = components['schemas']['EvalModelComparisonDto'];
 export type EvalInsightsDto = components['schemas']['EvalInsightsDto'];
+export type EvalPackSummaryDto = components['schemas']['EvalPackSummaryDto'];
+export type EvalPackListDto = components['schemas']['EvalPackListDto'];
 export type ResponseUnauthorized = components['responses']['Unauthorized'];
 export type ResponseForbidden = components['responses']['Forbidden'];
 export type ResponseZenHrSyncInProgress = components['responses']['ZenHrSyncInProgress'];
 export type ParameterWorkspaceId = components['parameters']['WorkspaceId'];
 export type ParameterEvalSuiteId = components['parameters']['EvalSuiteId'];
+export type ParameterEvalPackId = components['parameters']['EvalPackId'];
 export type ParameterEvalRunId = components['parameters']['EvalRunId'];
 export type ParameterRepoId = components['parameters']['RepoId'];
 export type ParameterProviderSlug = components['parameters']['ProviderSlug'];
@@ -24678,6 +24737,122 @@ export interface operations {
             };
         };
     };
+    listEvalPacks: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Starter pack catalog */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "packs": [
+                     *         {
+                     *           "id": "pr-review",
+                     *           "name": "PR review comments",
+                     *           "description": "Check review tone and clear blocking feedback",
+                     *           "workflow": "pr-review",
+                     *           "caseCount": 3
+                     *         }
+                     *       ]
+                     *     }
+                     */
+                    "application/json": components["schemas"]["EvalPackListDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            /** @description Workspace not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    installEvalPack: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+                /** @description Platform starter pack id (kebab-case), e.g. `pr-review`. Not a UUID. */
+                packId: components["parameters"]["EvalPackId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Suite created from pack */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EvalSuiteDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            /** @description Viewer cannot install packs */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Workspace editor role required",
+                     *       "code": "workspace_editor_required"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Unknown pack id or workspace not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Eval starter pack not found",
+                     *       "code": "eval_pack_not_found"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Workspace already has the maximum number of suites (50) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Maximum of 50 eval suites per workspace",
+                     *       "code": "eval_suite_limit_reached"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
     listEvalSuites: {
         parameters: {
             query?: never;