@vibexp/api-client 0.72.0 → 0.74.0

package/dist/schema.d.ts

@@ -569,6 +569,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/{team_id}/search/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Answer a query from the team's top search results
+         * @description Runs the team's search for the query, gives the full text of the top-N matching documents to the team's model provider, and returns a markdown answer grounded in them, citing each document as `[n]`. Always uses the global top-N results (there is no paging), and works the same whether search ranked them semantically or by the keyword fallback. Each document is truncated to a per-document budget, and documents stop being added once the total context budget is used, so `sources` lists exactly what the model saw. Any team member may call it. Errors never carry the provider's raw response.
+         */
+        post: operations["summarizeSearchResults"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/{team_id}/resource-access-metrics": {
         parameters: {
             query?: never;
@@ -4122,6 +4142,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/{team_id}/model-providers/models": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Team that owns the model provider(s). */
+                team_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * List a model provider's models
+         * @description Lists the models an OpenAI-compatible provider exposes via
+         *     `GET {base_url}/models`, so a model can be picked instead of typed. It
+         *     takes inline connection details and persists nothing, so it works before
+         *     the provider is saved; a blank `api_key` together with `provider_id`
+         *     reuses that saved provider's stored key.
+         *
+         *     The outcome is reported in the 200 body, like validate: a provider that
+         *     does not implement model listing, cannot be reached or rejects the key
+         *     answers `supported: false` with an empty `models` array, and `message`
+         *     carries a fixed failure category — never the provider's response or the
+         *     URL. The list is the provider's own, sorted by `id` and unfiltered. 500 is
+         *     returned only for internal service errors.
+         */
+        post: operations["listProviderModels"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/{team_id}/settings/model-providers": {
         parameters: {
             query?: never;
@@ -4220,6 +4274,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/{team_id}/settings/model-providers/models": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Team that owns the model provider(s). */
+                team_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * List a model provider's models
+         * @description Lists the models an OpenAI-compatible provider exposes via
+         *     `GET {base_url}/models`, so a model can be picked instead of typed. It
+         *     takes inline connection details and persists nothing, so it works before
+         *     the provider is saved; a blank `api_key` together with `provider_id`
+         *     reuses that saved provider's stored key.
+         *
+         *     The outcome is reported in the 200 body, like validate: a provider that
+         *     does not implement model listing, cannot be reached or rejects the key
+         *     answers `supported: false` with an empty `models` array, and `message`
+         *     carries a fixed failure category — never the provider's response or the
+         *     URL. The list is the provider's own, sorted by `id` and unfiltered. 500 is
+         *     returned only for internal service errors.
+         */
+        post: operations["listProviderModelsSettings"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/{team_id}/settings/model-providers/copy": {
         parameters: {
             query?: never;
@@ -6004,6 +6092,51 @@ export interface components {
                 error_details?: string;
             };
         };
+        /** @description Inline connection details for the provider whose models to list. The provider does not have to be saved yet: this is what lets a model be picked while the base URL and key are still being entered. */
+        ListProviderModelsRequest: {
+            /** @example openai_compatible */
+            provider_type: string;
+            /**
+             * Format: uri
+             * @example https://api.openai.com/v1
+             */
+            base_url: string;
+            /** @description Bearer key for the provider. Leave it blank together with `provider_id` to reuse that saved provider's stored key — the same rule an update applies to a blank key. */
+            api_key?: string | null;
+            /**
+             * Format: uuid
+             * @description A saved provider in this team whose stored API key is used when `api_key` is blank. Ignored when `api_key` is supplied.
+             * @example 550e8400-e29b-41d4-a716-446655440000
+             */
+            provider_id?: string;
+        };
+        ProviderModel: {
+            /**
+             * @description Model identifier, exactly as the provider reports it.
+             * @example gpt-4o-mini
+             */
+            id: string;
+            /**
+             * @description Owner the provider reports for the model, when it reports one.
+             * @example openai
+             */
+            owned_by?: string;
+        };
+        ProviderModelList: {
+            /**
+             * @description Whether the provider answered its model listing. `false` when it does not implement `GET {base_url}/models` (many gateways expose only `/chat/completions`) or could not be reached; a client falls back to free-text model entry.
+             * @example true
+             */
+            supported: boolean;
+            /** @description Every model the provider reported, sorted by `id` and unfiltered. Empty when `supported` is `false`. */
+            models: components["schemas"]["ProviderModel"][];
+            /**
+             * @description Why the listing failed, as a fixed category — never the provider's raw response or the URL. Omitted on success and when the provider simply does not implement model listing.
+             * @example unauthorized
+             * @enum {string}
+             */
+            message?: "connection_failed" | "unauthorized" | "misconfigured_provider" | "destination_not_allowed";
+        };
         /** @description A team's own GitHub App registration. Never carries secret values. */
         GitHubAppConfig: {
             /**
@@ -7467,6 +7600,108 @@ export interface components {
              */
             total_pages: number;
         };
+        SearchSummaryRequest: {
+            /**
+             * @description The question to answer. It is run through the team's search, and the top matching documents are what the answer is grounded in.
+             * @example how do we configure retries
+             */
+            query: string;
+            /**
+             * @description Resource types to draw documents from. Omit or leave empty to use all four types. Unknown values are rejected with a 400.
+             * @example [
+             *       "memories",
+             *       "blueprints"
+             *     ]
+             */
+            types?: ("prompts" | "artifacts" | "blueprints" | "memories")[];
+            /**
+             * Format: uuid
+             * @description Optional project UUID. When set, only documents in this project are used.
+             * @example 7c9e6679-7425-40de-944b-e07fc1f90ae7
+             */
+            project_id?: string;
+        };
+        /** @description One document the summary was grounded in. Its `index` is the number the summary cites it by (`[1]`, `[2]`, ...). */
+        SearchSummarySource: {
+            /**
+             * @description Citation number of this document in the summary, starting at 1
+             * @example 1
+             */
+            index: number;
+            /**
+             * @description Singular resource type of the document
+             * @example memory
+             * @enum {string}
+             */
+            type: "prompt" | "artifact" | "blueprint" | "memory";
+            /**
+             * Format: uuid
+             * @description ID of the document
+             */
+            id: string;
+            /**
+             * @description Title of the document
+             * @example Retry configuration guide
+             */
+            title: string;
+            /**
+             * @description Slug of the document, used to build slug-based detail-page links. Empty for memories, which are routed by id.
+             * @example retry-configuration-guide
+             */
+            slug: string;
+            /**
+             * Format: uuid
+             * @description UUID of the document's project
+             */
+            project_id: string;
+            /**
+             * @description Human-readable name of the document's project
+             * @example My Project
+             */
+            project_name: string;
+            /**
+             * Format: date-time
+             * @description Last-updated timestamp of the document
+             */
+            updated_at: string;
+            /** @description True when only the beginning of the document was given to the model, because it exceeded the per-document or total context budget. */
+            truncated: boolean;
+        };
+        /** @description Token usage the model provider reported for the completion. */
+        SearchSummaryUsage: {
+            /**
+             * @description Tokens in the prompt sent to the model
+             * @example 2400
+             */
+            prompt_tokens: number;
+            /**
+             * @description Tokens in the generated summary
+             * @example 310
+             */
+            completion_tokens: number;
+        };
+        SearchSummaryResponse: {
+            /** @description Markdown answer to the query, grounded in `sources` and citing them as `[n]`. When the documents do not contain the answer, the summary says so. */
+            summary: string;
+            /** @description The documents given to the model, in citation order. Only documents that were actually included are listed. */
+            sources: components["schemas"]["SearchSummarySource"][];
+            /**
+             * @description Model that generated the summary
+             * @example gpt-4o-mini
+             */
+            model: string;
+            /**
+             * Format: uuid
+             * @description ID of the team model provider that generated the summary
+             */
+            provider_id: string;
+            /**
+             * Format: date-time
+             * @description When the summary was generated
+             */
+            generated_at: string;
+            usage?: components["schemas"]["SearchSummaryUsage"];
+        };
         Blueprint: {
             /**
              * @description Unique identifier for the spec library
@@ -12842,6 +13077,105 @@ export interface operations {
             };
         };
     };
+    summarizeSearchResults: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Team ID */
+                team_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SearchSummaryRequest"];
+            };
+        };
+        responses: {
+            /** @description Summary generated successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SearchSummaryResponse"];
+                };
+            };
+            /** @description Invalid request data or validation error */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description User is not a member of the team */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description AI summaries are disabled for the team (`AI_SUMMARY_DISABLED`), or the team has no model provider (`AI_SUMMARY_NO_PROVIDER`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The search returned no documents to summarize (`AI_SUMMARY_NO_RESULTS`) */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Failed to generate the summary */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The model provider could not produce a summary: it was unreachable (`AI_SUMMARY_PROVIDER_UNREACHABLE`), rejected the credentials (`AI_SUMMARY_UNAUTHORIZED`), or rejected the request (`AI_SUMMARY_MODEL_ERROR`) */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The model provider did not answer in time (`AI_SUMMARY_TIMEOUT`) */
+            504: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     getResourceAccessMetrics: {
         parameters: {
             query: {
@@ -24552,6 +24886,78 @@ export interface operations {
             };
         };
     };
+    listProviderModels: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Team that owns the model provider(s). */
+                team_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ListProviderModelsRequest"];
+            };
+        };
+        responses: {
+            /** @description Listing completed (check `supported` for the outcome) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProviderModelList"];
+                };
+            };
+            /** @description Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden - managing provider settings requires team owner/admin (`FORBIDDEN`) */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description `api_key` was blank and `provider_id` names no provider in this team (`MODEL_PROVIDER_NOT_FOUND`) */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Listing failed due to an internal service error (`INTERNAL_ERROR`) */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listModelProvidersSettings: {
         parameters: {
             query?: never;
@@ -24922,6 +25328,78 @@ export interface operations {
             };
         };
     };
+    listProviderModelsSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Team that owns the model provider(s). */
+                team_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ListProviderModelsRequest"];
+            };
+        };
+        responses: {
+            /** @description Listing completed (check `supported` for the outcome) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProviderModelList"];
+                };
+            };
+            /** @description Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden - managing provider settings requires team owner/admin (`FORBIDDEN`) */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description `api_key` was blank and `provider_id` names no provider in this team (`MODEL_PROVIDER_NOT_FOUND`) */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Listing failed due to an internal service error (`INTERNAL_ERROR`) */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     copyModelProviderFromTeam: {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibexp/api-client",
-  "version": "0.72.0",
+  "version": "0.74.0",
   "description": "Typed VibeXP API client generated from the OpenAPI spec (openapi-fetch main entrypoint, axios SDK at ./axios)",
   "license": "MIT",
   "repository": {