@meetkai/mka1 0.48.24 → 0.48.25

package/README.md

@@ -139,6 +139,239 @@ For available server flags:
 npx -y --package @meetkai/mka1 -- mcp start --help
 ```
 
+<!-- Start Summary [summary] -->
+## Summary
+
+MKA1 API: The MKA1 API is a RESTful API that provides access to the MKA1 platform. Learn how to get started with the API and the TypeScript SDK [here](https://mka1.apidocumentation.com/guides/getting-started).
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [MKA1 TypeScript SDK](#mka1-typescript-sdk)
+  * [Install](#install)
+  * [Quick Start](#quick-start)
+  * [Authentication](#authentication)
+  * [Common Entry Points](#common-entry-points)
+  * [React Query](#react-query)
+  * [MCP Server](#mcp-server)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication-1)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
+  * [Server-sent event streaming](#server-sent-event-streaming)
+  * [File uploads](#file-uploads)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+  * [Versioning](#versioning)
+  * [Generated Code](#generated-code)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+> [!TIP]
+> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
+
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add git+https://github.com/MeetKai/mk1-sdks.git?subdir=typescript
+# Install optional peer dependencies if you plan to use React hooks
+npm add @tanstack/react-query react react-dom
+```
+
+### PNPM
+
+```bash
+pnpm add https://github.com/MeetKai/mk1-sdks#path:typescript
+# Install optional peer dependencies if you plan to use React hooks
+pnpm add @tanstack/react-query react react-dom
+```
+
+### Bun
+
+```bash
+bun add https://github.com/MeetKai/mk1-sdks
+# Install optional peer dependencies if you plan to use React hooks
+bun add @tanstack/react-query react react-dom
+```
+
+### Yarn
+
+```bash
+yarn add https://github.com/MeetKai/mk1-sdks
+# Install optional peer dependencies if you plan to use React hooks
+yarn add @tanstack/react-query react react-dom
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> Node.js v20 or greater is required to run the MCP server from npm.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "SDK": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@meetkai/mka1",
+        "--",
+        "mcp", "start",
+        "--bearer-auth", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Create a `.cursor/mcp.json` file in your project root with the following content:
+
+```json
+{
+  "mcpServers": {
+    "SDK": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@meetkai/mka1",
+        "--",
+        "mcp", "start",
+        "--bearer-auth", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
+
+```bash
+curl -L -o mcp-server \
+    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
+chmod +x mcp-server
+```
+
+If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
+
+
+```json
+{
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
+  }
+}
+```
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @meetkai/mka1 -- mcp start --help
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { SDK } from "@meetkai/mka1";
+
+const sdk = new SDK({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  await sdk.permissions.llm.grant({
+    grantPermissionRequest: {
+      resourceType: "completion",
+      resourceId: "my-completion-123",
+      userId: "user-abc456",
+      role: "writer",
+    },
+  });
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name         | Type | Scheme      |
+| ------------ | ---- | ----------- |
+| `bearerAuth` | http | HTTP Bearer |
+
+To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { SDK } from "@meetkai/mka1";
+
+const sdk = new SDK({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  await sdk.permissions.llm.grant({
+    grantPermissionRequest: {
+      resourceType: "completion",
+      resourceId: "my-completion-123",
+      userId: "user-abc456",
+      role: "writer",
+    },
+  });
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -163,6 +396,12 @@ npx -y --package @meetkai/mka1 -- mcp start --help
 * [pauseAgentSchedule](docs/sdks/agentschedules/README.md#pauseagentschedule) - Pause an agent schedule
 * [resumeAgentSchedule](docs/sdks/agentschedules/README.md#resumeagentschedule) - Resume an agent schedule
 
+### [AgentVersions](docs/sdks/agentversions/README.md)
+
+* [listAgentVersions](docs/sdks/agentversions/README.md#listagentversions) - List agent versions
+* [getAgentVersion](docs/sdks/agentversions/README.md#getagentversion) - Retrieve an agent version
+* [rollbackAgentVersion](docs/sdks/agentversions/README.md#rollbackagentversion) - Roll back an agent to a version
+
 ### [Agents](docs/sdks/agents/README.md)
 
 * [listAgents](docs/sdks/agents/README.md#listagents) - List agents
@@ -234,6 +473,13 @@ npx -y --package @meetkai/mka1 -- mcp start --help
 * [listSamples](docs/sdks/evals/README.md#listsamples) - List eval samples
 * [getArtifacts](docs/sdks/evals/README.md#getartifacts) - Get eval run artifacts
 * [importHistoricalResults](docs/sdks/evals/README.md#importhistoricalresults) - Import historical eval results from Hugging Face
+* [createSchedule](docs/sdks/evals/README.md#createschedule) - Create an eval schedule
+* [listSchedules](docs/sdks/evals/README.md#listschedules) - List eval schedules
+* [getSchedule](docs/sdks/evals/README.md#getschedule) - Get an eval schedule
+* [updateSchedule](docs/sdks/evals/README.md#updateschedule) - Update an eval schedule
+* [deleteSchedule](docs/sdks/evals/README.md#deleteschedule) - Delete an eval schedule
+* [triggerSchedule](docs/sdks/evals/README.md#triggerschedule) - Trigger an eval schedule now
+* [listScheduleRuns](docs/sdks/evals/README.md#listscheduleruns) - List runs created by an eval schedule
 
 ### [Llm.Extract](docs/sdks/extract/README.md)
 
@@ -495,6 +741,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`agentsGetAgent`](docs/sdks/agents/README.md#getagent) - Retrieve an agent
 - [`agentsListAgents`](docs/sdks/agents/README.md#listagents) - List agents
 - [`agentsUpdateAgent`](docs/sdks/agents/README.md#updateagent) - Update an agent
+- [`agentVersionsGetAgentVersion`](docs/sdks/agentversions/README.md#getagentversion) - Retrieve an agent version
+- [`agentVersionsListAgentVersions`](docs/sdks/agentversions/README.md#listagentversions) - List agent versions
+- [`agentVersionsRollbackAgentVersion`](docs/sdks/agentversions/README.md#rollbackagentversion) - Roll back an agent to a version
 - [`authApiKeyGetJwtFromKey`](docs/sdks/apikey/README.md#getjwtfromkey) - Exchange API key for a JWT token
 - [`guardrailsGetGuardrails`](docs/sdks/guardrails/README.md#getguardrails) - Get guardrails settings
 - [`guardrailsTestGuardrails`](docs/sdks/guardrails/README.md#testguardrails) - Test content against guardrails
@@ -518,21 +767,28 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`llmEmbeddingsListModels`](docs/sdks/embeddings/README.md#listmodels) - List available embedding models
 - [`llmEvalsCancelRun`](docs/sdks/evals/README.md#cancelrun) - Cancel an eval run
 - [`llmEvalsCreateRun`](docs/sdks/evals/README.md#createrun) - Create an eval run
+- [`llmEvalsCreateSchedule`](docs/sdks/evals/README.md#createschedule) - Create an eval schedule
 - [`llmEvalsCreateSuite`](docs/sdks/evals/README.md#createsuite) - Create an eval suite
 - [`llmEvalsCreateSuiteVersion`](docs/sdks/evals/README.md#createsuiteversion) - Create an eval suite version
 - [`llmEvalsDeleteRun`](docs/sdks/evals/README.md#deleterun) - Delete an eval run
+- [`llmEvalsDeleteSchedule`](docs/sdks/evals/README.md#deleteschedule) - Delete an eval schedule
 - [`llmEvalsDeleteSuite`](docs/sdks/evals/README.md#deletesuite) - Delete an eval suite
 - [`llmEvalsGetArtifacts`](docs/sdks/evals/README.md#getartifacts) - Get eval run artifacts
 - [`llmEvalsGetRun`](docs/sdks/evals/README.md#getrun) - Get an eval run
+- [`llmEvalsGetSchedule`](docs/sdks/evals/README.md#getschedule) - Get an eval schedule
 - [`llmEvalsGetSuite`](docs/sdks/evals/README.md#getsuite) - Get an eval suite
 - [`llmEvalsGetSuiteVersion`](docs/sdks/evals/README.md#getsuiteversion) - Get an eval suite version
 - [`llmEvalsImportHistoricalResults`](docs/sdks/evals/README.md#importhistoricalresults) - Import historical eval results from Hugging Face
 - [`llmEvalsListRuns`](docs/sdks/evals/README.md#listruns) - List eval runs
 - [`llmEvalsListSamples`](docs/sdks/evals/README.md#listsamples) - List eval samples
+- [`llmEvalsListScheduleRuns`](docs/sdks/evals/README.md#listscheduleruns) - List runs created by an eval schedule
+- [`llmEvalsListSchedules`](docs/sdks/evals/README.md#listschedules) - List eval schedules
 - [`llmEvalsListSuites`](docs/sdks/evals/README.md#listsuites) - List eval suites
 - [`llmEvalsListSuiteVersions`](docs/sdks/evals/README.md#listsuiteversions) - List eval suite versions
 - [`llmEvalsRerunFailedSamples`](docs/sdks/evals/README.md#rerunfailedsamples) - Rerun failed eval samples
 - [`llmEvalsRetryFailedRun`](docs/sdks/evals/README.md#retryfailedrun) - Retry an eval run
+- [`llmEvalsTriggerSchedule`](docs/sdks/evals/README.md#triggerschedule) - Trigger an eval schedule now
+- [`llmEvalsUpdateSchedule`](docs/sdks/evals/README.md#updateschedule) - Update an eval schedule
 - [`llmExtractCreateSchema`](docs/sdks/extract/README.md#createschema) - Create reusable extraction schema template
 - [`llmExtractDeleteSchema`](docs/sdks/extract/README.md#deleteschema) - Delete extraction schema by ID
 - [`llmExtractExtract`](docs/sdks/extract/README.md#extract) - Extract structured data with inline JSON Schema
@@ -743,6 +999,9 @@ To learn about this feature and how to get started, check
 - [`useAgentsGetAgent`](docs/sdks/agents/README.md#getagent) - Retrieve an agent
 - [`useAgentsListAgents`](docs/sdks/agents/README.md#listagents) - List agents
 - [`useAgentsUpdateAgentMutation`](docs/sdks/agents/README.md#updateagent) - Update an agent
+- [`useAgentVersionsGetAgentVersion`](docs/sdks/agentversions/README.md#getagentversion) - Retrieve an agent version
+- [`useAgentVersionsListAgentVersions`](docs/sdks/agentversions/README.md#listagentversions) - List agent versions
+- [`useAgentVersionsRollbackAgentVersionMutation`](docs/sdks/agentversions/README.md#rollbackagentversion) - Roll back an agent to a version
 - [`useAuthApiKeyGetJwtFromKeyMutation`](docs/sdks/apikey/README.md#getjwtfromkey) - Exchange API key for a JWT token
 - [`useGuardrailsGetGuardrails`](docs/sdks/guardrails/README.md#getguardrails) - Get guardrails settings
 - [`useGuardrailsTestGuardrailsMutation`](docs/sdks/guardrails/README.md#testguardrails) - Test content against guardrails
@@ -766,21 +1025,28 @@ To learn about this feature and how to get started, check
 - [`useLlmEmbeddingsListModels`](docs/sdks/embeddings/README.md#listmodels) - List available embedding models
 - [`useLlmEvalsCancelRunMutation`](docs/sdks/evals/README.md#cancelrun) - Cancel an eval run
 - [`useLlmEvalsCreateRunMutation`](docs/sdks/evals/README.md#createrun) - Create an eval run
+- [`useLlmEvalsCreateScheduleMutation`](docs/sdks/evals/README.md#createschedule) - Create an eval schedule
 - [`useLlmEvalsCreateSuiteMutation`](docs/sdks/evals/README.md#createsuite) - Create an eval suite
 - [`useLlmEvalsCreateSuiteVersionMutation`](docs/sdks/evals/README.md#createsuiteversion) - Create an eval suite version
 - [`useLlmEvalsDeleteRunMutation`](docs/sdks/evals/README.md#deleterun) - Delete an eval run
+- [`useLlmEvalsDeleteScheduleMutation`](docs/sdks/evals/README.md#deleteschedule) - Delete an eval schedule
 - [`useLlmEvalsDeleteSuiteMutation`](docs/sdks/evals/README.md#deletesuite) - Delete an eval suite
 - [`useLlmEvalsGetArtifacts`](docs/sdks/evals/README.md#getartifacts) - Get eval run artifacts
 - [`useLlmEvalsGetRun`](docs/sdks/evals/README.md#getrun) - Get an eval run
+- [`useLlmEvalsGetSchedule`](docs/sdks/evals/README.md#getschedule) - Get an eval schedule
 - [`useLlmEvalsGetSuite`](docs/sdks/evals/README.md#getsuite) - Get an eval suite
 - [`useLlmEvalsGetSuiteVersion`](docs/sdks/evals/README.md#getsuiteversion) - Get an eval suite version
 - [`useLlmEvalsImportHistoricalResultsMutation`](docs/sdks/evals/README.md#importhistoricalresults) - Import historical eval results from Hugging Face
 - [`useLlmEvalsListRuns`](docs/sdks/evals/README.md#listruns) - List eval runs
 - [`useLlmEvalsListSamples`](docs/sdks/evals/README.md#listsamples) - List eval samples
+- [`useLlmEvalsListScheduleRuns`](docs/sdks/evals/README.md#listscheduleruns) - List runs created by an eval schedule
+- [`useLlmEvalsListSchedules`](docs/sdks/evals/README.md#listschedules) - List eval schedules
 - [`useLlmEvalsListSuites`](docs/sdks/evals/README.md#listsuites) - List eval suites
 - [`useLlmEvalsListSuiteVersions`](docs/sdks/evals/README.md#listsuiteversions) - List eval suite versions
 - [`useLlmEvalsRerunFailedSamplesMutation`](docs/sdks/evals/README.md#rerunfailedsamples) - Rerun failed eval samples
 - [`useLlmEvalsRetryFailedRunMutation`](docs/sdks/evals/README.md#retryfailedrun) - Retry an eval run
+- [`useLlmEvalsTriggerScheduleMutation`](docs/sdks/evals/README.md#triggerschedule) - Trigger an eval schedule now
+- [`useLlmEvalsUpdateScheduleMutation`](docs/sdks/evals/README.md#updateschedule) - Update an eval schedule
 - [`useLlmExtractCreateSchemaMutation`](docs/sdks/extract/README.md#createschema) - Create reusable extraction schema template
 - [`useLlmExtractDeleteSchemaMutation`](docs/sdks/extract/README.md#deleteschema) - Delete extraction schema by ID
 - [`useLlmExtractExtractMutation`](docs/sdks/extract/README.md#extract) - Extract structured data with inline JSON Schema
@@ -1165,20 +1431,20 @@ run();
 
 
 **Inherit from [`SDKError`](./src/models/errors/sdkerror.ts)**:
-* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 33 of 222 methods.*
-* [`ErrorEnvelope`](./src/models/errors/errorenvelope.ts): Error response. Applicable to 17 of 222 methods.*
-* [`TableErrorResponse`](./src/models/errors/tableerrorresponse.ts): Applicable to 9 of 222 methods.*
-* [`TextStoreErrorResponse`](./src/models/errors/textstoreerrorresponse.ts): Error response for text store operations. Applicable to 5 of 222 methods.*
-* [`GraphRAGErrorResponse`](./src/models/errors/graphragerrorresponse.ts): Applicable to 5 of 222 methods.*
-* [`ValidationErrorResponse`](./src/models/errors/validationerrorresponse.ts): Status code `400`. Applicable to 3 of 222 methods.*
-* [`ErrorResponse`](./src/models/errors/errorresponse.ts): Status code `400`. Applicable to 2 of 222 methods.*
-* [`GetFileContentResponseBody`](./src/models/errors/getfilecontentresponsebody.ts): Invalid request - File ID is required. Status code `400`. Applicable to 1 of 222 methods.*
-* [`GetJwtFromKeyResponseBody`](./src/models/errors/getjwtfromkeyresponsebody.ts): Invalid request body. Status code `400`. Applicable to 1 of 222 methods.*
-* [`GetFileContentLlmFilesResponseBody`](./src/models/errors/getfilecontentllmfilesresponsebody.ts): Unauthorized - Invalid or missing authentication. Status code `401`. Applicable to 1 of 222 methods.*
-* [`GetJwtFromKeyAuthApiKeyResponseBody`](./src/models/errors/getjwtfromkeyauthapikeyresponsebody.ts): Unauthorized. Status code `401`. Applicable to 1 of 222 methods.*
-* [`GetFileContentLlmFilesResponseResponseBody`](./src/models/errors/getfilecontentllmfilesresponseresponsebody.ts): File not found. Status code `404`. Applicable to 1 of 222 methods.*
-* [`GetFileContentLlmFilesResponse500ResponseBody`](./src/models/errors/getfilecontentllmfilesresponse500responsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 222 methods.*
-* [`GetJwtFromKeyAuthApiKeyResponseResponseBody`](./src/models/errors/getjwtfromkeyauthapikeyresponseresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 222 methods.*
+* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 33 of 232 methods.*
+* [`ErrorEnvelope`](./src/models/errors/errorenvelope.ts): Error response. Applicable to 20 of 232 methods.*
+* [`TableErrorResponse`](./src/models/errors/tableerrorresponse.ts): Applicable to 9 of 232 methods.*
+* [`TextStoreErrorResponse`](./src/models/errors/textstoreerrorresponse.ts): Error response for text store operations. Applicable to 5 of 232 methods.*
+* [`GraphRAGErrorResponse`](./src/models/errors/graphragerrorresponse.ts): Applicable to 5 of 232 methods.*
+* [`ValidationErrorResponse`](./src/models/errors/validationerrorresponse.ts): Status code `400`. Applicable to 3 of 232 methods.*
+* [`ErrorResponse`](./src/models/errors/errorresponse.ts): Status code `400`. Applicable to 2 of 232 methods.*
+* [`GetFileContentResponseBody`](./src/models/errors/getfilecontentresponsebody.ts): Invalid request - File ID is required. Status code `400`. Applicable to 1 of 232 methods.*
+* [`GetJwtFromKeyResponseBody`](./src/models/errors/getjwtfromkeyresponsebody.ts): Invalid request body. Status code `400`. Applicable to 1 of 232 methods.*
+* [`GetFileContentLlmFilesResponseBody`](./src/models/errors/getfilecontentllmfilesresponsebody.ts): Unauthorized - Invalid or missing authentication. Status code `401`. Applicable to 1 of 232 methods.*
+* [`GetJwtFromKeyAuthApiKeyResponseBody`](./src/models/errors/getjwtfromkeyauthapikeyresponsebody.ts): Unauthorized. Status code `401`. Applicable to 1 of 232 methods.*
+* [`GetFileContentLlmFilesResponseResponseBody`](./src/models/errors/getfilecontentllmfilesresponseresponsebody.ts): File not found. Status code `404`. Applicable to 1 of 232 methods.*
+* [`GetFileContentLlmFilesResponse500ResponseBody`](./src/models/errors/getfilecontentllmfilesresponse500responsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 232 methods.*
+* [`GetJwtFromKeyAuthApiKeyResponseResponseBody`](./src/models/errors/getjwtfromkeyauthapikeyresponseresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 232 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>
@@ -1329,3 +1595,5 @@ The SDK is generated from the MKA1 OpenAPI schema and may gain new endpoints fre
 Most files under `src/`, `docs/`, and the generated reference sections in this README are produced from the API schema. Changes to generated implementation files are likely to be overwritten by the next SDK generation. For API behavior questions, integration support, or documentation issues, use the support channels listed at [docs.mka1.com](https://docs.mka1.com).
 
 Generated with [Speakeasy](https://www.speakeasy.com/).
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->