feat(portal): add an Ask AI copilot chat and a portal copilot sync command

README.md

@@ -47,6 +47,7 @@ USAGE
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
 * [`apimatic plugin generate`](#apimatic-plugin-generate)
 * [`apimatic plugin publish`](#apimatic-plugin-publish)
+* [`apimatic portal copilot sync`](#apimatic-portal-copilot-sync)
 * [`apimatic portal generate`](#apimatic-portal-generate)
 * [`apimatic portal serve`](#apimatic-portal-serve)
 * [`apimatic publishing profile list`](#apimatic-publishing-profile-list)
@@ -290,6 +291,47 @@ EXAMPLES
 
 _See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/publish.ts)_
 
+## `apimatic portal copilot sync`
+
+Update the portal's Ask AI chat with the portal's current pages.
+
+```
+USAGE
+  $ apimatic portal copilot sync [--wait] [-d <value>] [-i <value>] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: <input>/portal] path to the generated portal to sync.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
+      --[no-]wait            wait until the pages are indexed; with --no-wait, return as soon as they are uploaded.
+
+DESCRIPTION
+  Update the portal's Ask AI chat with the portal's current pages.
+
+  Uploads the pages of a generated portal to the Ask AI service, so the portal's Ask AI chat answers from the docs as
+  they are now.
+
+  The service picks up the pages by itself from a portal deployed at its 'site.url'. Run this command after deploying a
+  portal generated with 'apimatic portal generate' when it cannot: for a portal without 'site.url', or one the service
+  cannot reach, such as one on a private network.
+
+  The service is set by the 'ai.copilot' setting in the 'portal' block of 'src/apimatic.json': APIMatic's Ask AI
+  service, or one on this machine. The pages are swapped in at once, after all of them are indexed; until then Ask AI
+  answers from the previous ones.
+
+  The upload is made with your saved APIMatic login, or with the auth key passed with --auth-key.
+
+EXAMPLES
+  apimatic portal copilot sync
+
+  apimatic portal copilot sync --input=./ --destination=./portal
+
+  apimatic portal copilot sync --no-wait
+```
+
+_See code: [src/commands/portal/copilot/sync.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/copilot/sync.ts)_
+
 ## `apimatic portal generate`
 
 Generate a static API Documentation Portal.

apimatic.schema.json

@@ -174,6 +174,30 @@
               "type": "boolean",
               "default": true,
               "description": "Whether each page offers to open itself in an external AI assistant."
+            },
+            "copilot": {
+              "type": "object",
+              "description": "The Ask AI chat the portal offers. Left out, the portal offers none.",
+              "additionalProperties": false,
+              "required": ["key", "apiUrl"],
+              "properties": {
+                "key": {
+                  "type": "string",
+                  "description": "A public Ask AI key, bound to this portal and to the origins allowed to use it.",
+                  "minLength": 1
+                },
+                "apiUrl": {
+                  "type": "string",
+                  "description": "The address of APIMatic's Ask AI service, such as 'https://ask.apimatic.io', or of one on this machine while developing it, such as 'http://localhost:8787'. The address alone, without a path.",
+                  "pattern": "^([hH][tT][tT][pP][sS]://([A-Za-z0-9_-]+\\.)*[aA][pP][iI][mM][aA][tT][iI][cC]\\.[iI][oO]|[hH][tT][tT][pP][sS]?://([lL][oO][cC][aA][lL][hH][oO][sS][tT]|127\\.0\\.0\\.1|\\[::1\\]))(:(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0))?/?$"
+                },
+                "suggestions": {
+                  "type": "array",
+                  "description": "Up to three starter questions shown on a new chat, such as 'How do I authenticate?'. Left out, the chat shows its own.",
+                  "maxItems": 3,
+                  "items": { "type": "string", "minLength": 1, "maxLength": 120 }
+                }
+              }
             }
           }
         },

eslint.config.js

@@ -40,7 +40,13 @@ export default [
         before: 'readonly',
         beforeEach: 'readonly',
         after: 'readonly',
-        afterEach: 'readonly'
+        afterEach: 'readonly',
+        // The portal template's browser code is tested against Node's own fetch API.
+        fetch: 'readonly',
+        Headers: 'readonly',
+        Response: 'readonly',
+        RequestInfo: 'readonly',
+        RequestInit: 'readonly'
       }
     },
     rules: {

package.json

@@ -54,11 +54,13 @@
         "test": "tsx node_modules/mocha/bin/_mocha --forbid-only \"test/**/*.test.ts\" --timeout 99999"
     },
     "dependencies": {
+        "@ai-sdk/react": "4.0.131",
         "@apimatic/sdk": "0.2.0-alpha.10",
         "@clack/core": "1.0.0-alpha.1",
         "@clack/prompts": "1.0.0-alpha.1",
         "@fontsource-variable/geist": "5.3.0",
         "@fontsource-variable/geist-mono": "5.3.0",
+        "@fumadocs/ai-chat": "0.1.0",
         "@fumadocs/api-docs": "0.2.8",
         "@oclif/core": "^4.2.8",
         "@oclif/plugin-autocomplete": "^3.2.24",
@@ -70,6 +72,7 @@
         "@tanstack/start-static-server-functions": "1.167.33",
         "@vitejs/plugin-react": "6.1.1",
         "adm-zip": "^0.5.17",
+        "ai": "7.0.128",
         "ansis": "^3.17.0",
         "async-mutex": "^0.5.0",
         "axios": "^1.8.1",
@@ -177,6 +180,9 @@
             "portal": {
                 "description": "Build and serve an API Documentation portal for your APIs."
             },
+            "portal:copilot": {
+                "description": "Keep your portal's Ask AI chat in sync with its pages."
+            },
             "sdk": {
                 "description": "Generate and publish SDKs for your APIs in multiple languages."
             },