@meetkai/mka1
v0.54.62
Published
Official TypeScript SDK for the MKA1 API.
Readme
MKA1 TypeScript SDK
Official TypeScript SDK for the MKA1 API.
Use @meetkai/mka1 to call MKA1 from Node.js, browsers, React apps, and agent tooling. The SDK includes typed clients for responses, agents, files, vector stores, evals, usage, model registry operations, guardrails, sandbox APIs, and more.
Full product and API documentation lives at docs.mka1.com.
Install
npm add @meetkai/mka1pnpm add @meetkai/mka1bun add @meetkai/mka1yarn add @meetkai/mka1The package ships both ESM and CommonJS builds. For supported runtimes, see RUNTIMES.md.
Quick Start
import { SDK } from "@meetkai/mka1";
const mka1 = new SDK({
bearerAuth: process.env.MKA1_API_KEY,
});
const models = await mka1.llm.models.list({});
console.log(models.data.map((model) => model.id));Most write APIs use the same client:
import { SDK } from "@meetkai/mka1";
const mka1 = new SDK({
bearerAuth: process.env.MKA1_API_KEY,
});
const response = await mka1.llm.responses.create({
responsesCreateRequest: {
model: "<MODEL_ID>",
input: "Summarize the latest MKA1 eval run.",
},
});
console.log(response);Authentication
Pass an MKA1 API key or bearer token when constructing the client:
const mka1 = new SDK({
bearerAuth: process.env.MKA1_API_KEY,
});You can also provide an async token resolver:
const mka1 = new SDK({
bearerAuth: async () => refreshMka1Token(),
});For account setup, API keys, and endpoint-specific examples, see docs.mka1.com.
Common Entry Points
mka1.llm.responses
mka1.llm.conversations
mka1.llm.files
mka1.llm.vectorStores
mka1.llm.evals
mka1.llm.models
mka1.llm.usage
mka1.agents
mka1.agentRuns
mka1.sandbox
mka1.permissionsThe generated method reference below lists every resource and operation included in this SDK.
React Query
React hooks are available from @meetkai/mka1/react-query. Install the optional peer dependencies only if you plan to use those hooks:
npm add @tanstack/react-query react react-domSee REACT_QUERY.md for provider setup, suspense hooks, invalidation helpers, and mutation examples.
MCP Server
This package also exposes the MKA1 API as an installable Model Context Protocol server.
Node.js v20 or newer is required for the MCP server.
{
"mcpServers": {
"mka1": {
"command": "npx",
"args": [
"-y",
"--package",
"@meetkai/mka1",
"--",
"mcp",
"start",
"--bearer-auth",
"..."
]
}
}
}For available server flags:
npx -y --package @meetkai/mka1 -- mcp start --helpSummary
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.
Table of Contents
- MKA1 TypeScript SDK
- Install
- Quick Start
- Authentication
- Common Entry Points
- React Query
- MCP Server
- SDK Installation
- Requirements
- SDK Example Usage
- Authentication
- Available Resources and Operations
- Standalone functions
- React hooks with TanStack Query
- Server-sent event streaming
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Debugging
- Versioning
- Generated Code
SDK Installation
[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
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-domPNPM
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-domBun
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-domYarn
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.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"SDK": {
"command": "npx",
"args": [
"-y", "--package", "@meetkai/mka1",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"SDK": {
"command": "npx",
"args": [
"-y", "--package", "@meetkai/mka1",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-serverIf the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}For a full list of server arguments, run:
npx -y --package @meetkai/mka1 -- mcp start --helpRequirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
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();
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:
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();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { SDK } from "@meetkai/mka1";
const sdk = new SDK();
async function run() {
const result = await sdk.auth.orgs.getById({}, {
orgId: "<id>",
});
console.log(result);
}
run();
Available Resources and Operations
AgentConnectors
- listAgentConnectors - List connectors for an agent
- createAgentConnector - Create a connector
- setupWhatsAppAppWebhook - Set up a WhatsApp app webhook (Beta)
- getAgentConnector - Retrieve a connector
- deleteAgentConnector - Delete a connector
- activateAgentConnector - Activate a connector
AgentRuns
- listAgentRuns - List runs for an agent
- createAgentRun - Start a saved agent run
- streamAgentRunEvents - Stream agent run events
- wakeAgentRun - Wake a sleeping agent run
- decideAgentRunMcpApproval - Approve or deny a pending MCP tool call
- getAgentRun - Retrieve an agent run
AgentSchedules
- listAgentSchedules - List schedules for an agent
- createAgentSchedule - Create an agent schedule
- getAgentSchedule - Retrieve an agent schedule
- updateAgentSchedule - Update an agent schedule
- deleteAgentSchedule - Delete an agent schedule
- pauseAgentSchedule - Pause an agent schedule
- resumeAgentSchedule - Resume an agent schedule
AgentVersions
- listAgentVersions - List agent versions
- getAgentVersion - Retrieve an agent version
- rollbackAgentVersion - Roll back an agent to a version
Agents
- listAgents - List agents
- createAgent - Create an agent
- getAgent - Retrieve an agent
- updateAgent - Update an agent
- deleteAgent - Delete an agent
Analytics
Analytics.Events
- search - Search events in a time range
Analytics.Keys
- create - Create a capture key and return its secret once
- list - List capture key metadata
- revoke - Revoke a capture key
Analytics.Projects
- create - Create an analytics project
- list - List accessible analytics projects
- get - Get an analytics project
- update - Rename an active analytics project
- archive - Archive an analytics project
Analytics.Visitors
- search - Search visitors in a time range
~~Auth.ApiKey~~
- ~~getJwtFromKey~~ - Exchange API key for a JWT token :warning: Deprecated Use exchangeToken instead.
Auth.ApiKeys
- create - Mint a scoped API key
- list - List scoped API keys
- update - Update a scoped API key
- regenerate - Rotate a scoped API key's secret
- exchangeToken - Exchange API key for a JWT token
Auth.Cluster
- createInvite - Create a cluster invitation
- listInvites - List cluster invitations
- updateInvite - Update a pending cluster invitation
- revokeInvite - Revoke a cluster invitation
- listOrgs - List all organizations
- getOrg - Get an organization
- deleteOrg - Soft-delete an organization
- inviteOrgMembers - Invite members on behalf of an organization
- suspendOrg - Suspend an organization
- unsuspendOrg - Unsuspend an organization
- reissueOwnerKey - Re-issue an org owner key (recovery)
- inviteInfo - Read cluster-invite info (public)
- acceptInvite - Accept a cluster invitation (public)
Auth.Orgs
- getById - Get basic organization details
- update - Patch organization metadata (cluster-admin)
- getQuota - Get an org's usage quota
- updateQuota - Set an org's usage quota (cluster-admin)
- getRateLimit - Get an org's rate limit
- updateRateLimit - Set an org's rate limit (cluster-admin)
Auth.ServiceAccounts
- create - Create a service account
- list - List service accounts
- get - Get a service account
- delete - Delete a service account
- listApiKeys - List a service account's API keys
- updateApiKey - Update a service-account API key
- deleteApiKey - Delete a service-account API key
- regenerateApiKey - Rotate a service-account API key's secret
Auth.Teams
- create - Create a team
- list - List teams in an org
- get - Get a team
- update - Rename a team
- delete - Delete a team
- addMember - Add a team member
- listMembers - List team members
- removeMember - Remove a team member
Budgets
- list - List budgets
- getOrg - List org budgets
- setOrg - Set an org budget
- deleteOrg - Delete an org budget
- orgEvents - List org budget events
- getApiKey - List apikey budgets
- setApiKey - Set an apikey budget
- deleteApiKey - Delete an apikey budget
- apiKeyEvents - List apikey budget events
- getUser - List user budgets
- setUser - Set a user budget
- deleteUser - Delete a user budget
- userEvents - List user budget events
- getTeam - List team budgets
- setTeam - Set a team budget
- deleteTeam - Delete a team budget
- teamEvents - List team budget events
- getExternalUser - List external user budgets
- setExternalUser - Set a external user budget
- deleteExternalUser - Delete a external user budget
- externalUserEvents - List external user budget events
- getUserDefault - List per-user default budgets
- setUserDefault - Set a per-user default budget
- deleteUserDefault - Delete a per-user default budget
- userDefaultEvents - List per-user default budget events
- getTeamDefault - List per-team default budgets
- setTeamDefault - Set a per-team default budget
- deleteTeamDefault - Delete a per-team default budget
- teamDefaultEvents - List per-team default budget events
- getExternalUserDefault - List per-external user default budgets
- setExternalUserDefault - Set a per-external user default budget
- deleteExternalUserDefault - Delete a per-external user default budget
- externalUserDefaultEvents - List per-external user default budget events
- getCurrency - Get display currency
- setCurrency - Set display currency
ComputeCatalog
- listAccelerators - List accelerators
- getAccelerator - Get an accelerator
- listComputeOffers - List provider offers
- listComputeProviders - List provider health
- createComputeQuote - Create a quote
ComputeJobs
- listJobs - List jobs
- createJob - Create a job
- getJob - Get a job
- listJobEvents - List job events
- listJobInstances - List observed job instances
- listJobLogs - List job logs
- terminateJob - Terminate a job
ComputePricing
- getPricing - Get the latest committed storage price
- putPricing - Create an immutable storage-price version
ComputeSecrets
- listComputeSecrets - List secrets
- createComputeSecret - Create a secret
- deleteComputeSecret - Delete a secret
- getComputeSecret - Get a secret
ComputeServices
- listServices - List services
- createService - Create a service
- getService - Get a service
- listServiceEvents - List service events
- listServiceInstances - List observed service instances
- listServiceLogs - List service logs
- updateServiceScaling - Replace a service scaling policy
- terminateService - Terminate a service
ComputeTenants
- listComputeTenants - List tenants
- getComputeTenant - Get a tenant
- putComputeTenant - Update a tenant
ComputeUsage
- getComputeUsage - Get usage
ComputeVolumes
- listStandaloneVolumes - List organization volumes
- createStandaloneVolume - Create a standalone shared volume
- deleteStandaloneVolume - Permanently delete a standalone volume
- getStandaloneVolume - Get a standalone volume
- listStandaloneVolumeAttachments - List volume attachments
Datasets
- listGenerators - List Generators
- getGenerator - Get Generator
- quoteGenerator - Quote Generator
- listGenerations - List Generations
- createGeneration - Create Generation
- getGeneration - Get Generation
- getGenerationLogs - Get Logs
- getGenerationEvents - Get Events
- cancelGeneration - Cancel Generation
- listFormats - List Formats
- getFormat - Get Format
Flags
- list - List flags
- create - Create a flag
- delete - Delete a flag and its settings in every environment
- get - Get a flag
- update - Update a flag's name, description, default value, or project
- archive - Archive a flag
- setEnvironmentState - Replace a flag's settings in one environment
- unarchive - Restore an archived flag
Flags.Audit
- list - List audit entries, newest first
Flags.Environments
- list - List environments
- create - Create an environment
- delete - Delete an environment and every flag setting in it
- update - Rename an environment
- evaluate - Evaluate every flag for an identity
- evaluateWithTraits - Evaluate every flag for an identity with traits
- revokeEvaluationKey - Revoke an environment evaluation key
- generateEvaluationKey - Generate or replace an environment evaluation key
Flags.Projects
- list - List projects
- create - Create a project
- delete - Delete an empty project
- get - Get a project
- update - Rename a project
Guardrails
- getGuardrails - Get effective guardrails
- updateGuardrails - Update guardrails policy
- deleteGuardrails - Delete guardrails policy
- listGuardrailsPolicies - List guardrails policies
- testGuardrails - Test content against guardrails
Llm.Batches
~~Llm.Chat~~
- ~~createChat~~ - [Deprecated] Chat completions for OpenAI SDK/client usage :warning: Deprecated
- ~~stream~~ - [Deprecated] Streaming chat completions for generated SDK usage :warning: Deprecated
Llm.Classify
- classify - Classify text into predefined categories
Llm.Conversations
- create - Create a conversation
- list - List conversations
- get - Retrieve a conversation
- update - Update a conversation
- delete - Delete a conversation
- listItems - List conversation items
- createItems - Create conversation items
- deleteItems - Delete multiple conversation items
- getItem - Retrieve a conversation item
- deleteItem - Delete a conversation item
Llm.Embeddings
- listModels - List available embedding models
- embed - Create text embeddings
Llm.Evals
- createSuite - Create an eval suite
- listSuites - List eval suites
- getSuite - Get an eval suite
- deleteSuite - Delete an eval suite
- createSuiteVersion - Create an eval suite version
- listSuiteVersions - List eval suite versions
- getSuiteVersion - Get an eval suite version
- listSuiteLeaderboardRuns - List leaderboard runs for an eval suite
- getSuiteLeaderboard - Get the coding-agent leaderboard for an eval suite
- createRun - Create an eval run
- listRuns - List eval runs
- getRun - Get an eval run
- deleteRun - Delete an eval run
- cancelRun - Cancel an eval run
- rerunFailedSamples - Rerun failed eval samples
- retryFailedRun - Retry an eval run
- getRunOverview - Get an eval run overview
- listSamples - List eval samples
- getSampleAudio - Get eval sample audio
- getSampleTrajectory - Get an eval sample trajectory
- uploadSampleTrajectory - Upload an eval sample trajectory
- getArtifacts - Get eval run artifacts
- importAgentRun - Import a finished coding-agent run
- appendAgentTrials - Append trials to an open coding-agent run
- importHistoricalResults - Import historical eval results from Hugging Face
- createSchedule - Create an eval schedule
- listSchedules - List eval schedules
- getSchedule - Get an eval schedule
- updateSchedule - Update an eval schedule
- deleteSchedule - Delete an eval schedule
- triggerSchedule - Trigger an eval schedule now
- listScheduleRuns - List runs created by an eval schedule
Llm.Extract
- extract - Extract structured data with inline JSON Schema
- createSchema - Create reusable extraction schema template
- getSchema - Get extraction schema by ID
- updateSchema - Update extraction schema by ID
- deleteSchema - Delete extraction schema by ID
- extractWithSchema - Extract data using saved schema template
Llm.Feedback
- createCompletionFeedback - Submit feedback for chat completion
- listCompletionFeedback - List chat completion feedback
- getCompletionFeedback - Retrieve feedback by completion ID
- updateCompletionFeedback - Update existing completion feedback
- batchGetCompletionFeedback - Batch retrieve feedback for multiple completions
- createResponseFeedback - Submit feedback for response
- listResponseFeedback - List response feedback
- getResponseFeedback - Retrieve feedback by response ID
- updateResponseFeedback - Update existing response feedback
- batchGetResponseFeedback - Batch retrieve feedback for multiple responses
- exportCompletionFeedback - Export completion feedback as CSV
- exportResponseFeedback - Export response feedback as CSV
- startExport - Start feedback export
- getExportStatus - Get feedback export status
Llm.Files
- upload - Upload file
- list - List files
- get - Retrieve file
- delete - Delete file
- content - Retrieve file content
~~Llm.FineTuning~~
- ~~create~~ - [Deprecated] Create a fine-tuning job :warning: Deprecated
- ~~list~~ - [Deprecated] List fine-tuning jobs :warning: Deprecated
- ~~retrieve~~ - [Deprecated] Retrieve a fine-tuning job :warning: Deprecated
- ~~cancel~~ - [Deprecated] Cancel a fine-tuning job :warning: Deprecated
- ~~pause~~ - [Deprecated] Pause a fine-tuning job :warning: Deprecated
- ~~resume~~ - [Deprecated] Resume a fine-tuning job :warning: Deprecated
- ~~listEvents~~ - [Deprecated] List fine-tuning events :warning: Deprecated
- ~~listCheckpoints~~ - [Deprecated] List fine-tuning checkpoints :warning: Deprecated
Llm.Images
- create - Generate images from text descriptions
Llm.McpVault
- createServer - Create MCP server
- listServers - List MCP servers
- getServer - Retrieve MCP server
- updateServer - Update MCP server
- deleteServer - Delete MCP server
- createCredential - Create MCP credential
- listCredentials - List MCP credentials
- deleteCredential - Delete MCP credential
- testServer - Test MCP server
Llm.MemoryStores
- create - Create memory store
- list - List memory stores
- get - Retrieve memory store
- update - Update memory store
- delete - Delete memory store
- createEntry - Create memory entry
- listEntries - List memory entries
- getEntry - Retrieve memory entry
- updateEntry - Update memory entry
- deleteEntry - Delete memory entry
Llm.Models
- list - List available models
- get - Retrieve a model
- listCatalog - List the organization's model catalog
- addCatalogEntry - Define a BYO catalog model
- updateCatalogEntry - Update a BYO catalog model
- deleteCatalogEntry - Remove a BYO catalog model
- checkCatalogHealth - Check a BYO catalog model's health
- listCatalogOrgAccess - List an organization's cluster model access
- addCatalogOrgAccess - Add cluster model access for an organization
- replaceCatalogOrgAccess - Replace an organization's cluster model access
- listCatalogModelAccess - List organizations with access to a cluster model
- listRegistry - List the organization's active model registry
- activateRegistryEntry - Activate a catalog entry
- deactivateRegistryEntry - Deactivate a model registry name
- listOrgAutoModels - List this org's auto-model overrides
- putOrgAutoModel - Set this org's auto policy for an endpoint
- deleteOrgAutoModel - Clear this org's auto-model override for an endpoint
- getClusterCurrency - Get the cluster currency
- setClusterCurrency - Set the cluster currency
- listClusterPrices - List cluster-default model prices
- setClusterPrice - Set a cluster-default model price
- clearClusterPrice - Clear a cluster-default model price
- listOrgPrices - List an org's price overrides
- setOrgPrice - Set an org price override
- clearOrgPrice - Clear an org price override
- listEffectivePrices - List effective prices for the caller's models
Llm.Prompts
- create - Create a prompt
- list - List prompts
- get - Get a prompt
- update - Update a prompt
- delete - Delete a prompt
- createVersion - Create a new version
- listVersions - List versions
- getVersion - Get a specific version
- rollback - Rollback to a version
Llm.Responses
- create - Create an agent-powered response with tool support
- list - List all responses with pagination
- get - Retrieve response by ID with status and results
- update - Update a response
- delete - Permanently delete a response and its data
- cancel - Cancel an in-progress background response
- wake - Wake a sleeping background response
- listInputItems - List paginated input items for a response
- compact - Compact a conversation
Llm.Skills
- create - Create skill
- list - List skills
- get - Retrieve skill
- update - Update skill
- delete - Delete skill
- content - Download skill content
- createVersion - Create skill version
- listVersions - List skill versions
- getVersion - Retrieve skill version
- deleteVersion - Delete skill version
- versionContent - Download skill version content
- listPreconfigured - List preconfigured skills
Llm.Speech
- transcribe - Speech to text transcription
- speak - Text to speech
- speakStreaming - Streaming text to speech
- livekitToken - Generate LiveKit room token
- listTtsHistory - List text-to-speech history
- getTtsHistory - Retrieve text-to-speech history item
- deleteTtsHistory - Delete text-to-speech history item
- getTtsHistoryContent - Retrieve text-to-speech audio
- listTranscriptionHistory - List speech-to-text history
- getTranscriptionHistory - Retrieve speech-to-text history item
- deleteTranscriptionHistory - Delete speech-to-text history item
- getTranscriptionHistoryContent - Retrieve speech-to-text audio
Llm.Usage
- completions - Get completions usage
- responses - Get responses usage
- conversations - Get conversations usage
- embeddings - Get embeddings usage
- extract - Get extract usage
- classify - Get classify usage
- vectorStores - Get vector stores usage
- files - Get files usage
- costs - Get cost by model
Llm.VectorStores
- create - Create a vector store
- list - List vector stores
- get - Retrieve a vector store
- update - Modify a vector store
- delete - Delete a vector store
- search - Search a vector store
- createFile - Add a file to a vector store
- listFiles - List files in a vector store
- getFile - Retrieve a vector store file
- updateFile - Update file attributes
- deleteFile - Remove file from vector store
- getFileContent - Retrieve parsed file content
- createFileBatch - Batch add multiple files to vector store
- getFileBatch - Retrieve file batch status
- cancelFileBatch - Cancel batch file processing
- listFilesInBatch - List files in a batch
Permissions.Llm
- grant - Grant permission to a user or make public
- revoke - Revoke permission from a user or remove public access
- check - Check user permission
Repos
- list - List the caller's org's repositories
- create - Create a repository
- delete - Delete a repository
- get - Get a repository
- update - Update a repository's labels
Repos.Tags
Sandbox
- create - Create Session
- list - List Sessions
- get - Get Session
- getPricing - Get Sandbox Pricing
- setPricing - Set Sandbox Pricing
- getBrowserUrl - Get Browser Session URL
- ~~getUrl~~ - Get Browser Session URL (Deprecated) :warning: Deprecated Use getBrowserUrl instead.
- proxyBrowserPortRequest - Proxy Browser Port Request
- runCommand - Run Command
- runCode - Run Code
- terminate - Terminate Session
- getWorkspace - Get Workspace Manifest
- downloadFile - Download Workspace File
- uploadFile - Upload Workspace File
- downloadArchive - Download Workspace Archive
- uploadArchive - Upload Workspace Archive
Sandbox.Environments
- list - List Environments
- create - Create Environment
- get - Get Environment
- update - Update Environment
- delete - Delete Environment
- runSetup - Run Environment Setup
Sandbox.Github
- createAuthorizationIntent - Start GitHub Authorization
- connect - Connect GitHub Account
- getConnection - Get GitHub Connection
- disconnect - Disconnect GitHub Account
- listRepositories - List GitHub Repositories
- refreshRepositories - Refresh GitHub Repositories
- resolveReference - Resolve GitHub Reference
- cloneRepository - Clone GitHub Repository into Session
- listSessionRepositories - List Session Repositories
- addSessionRepository - Add Session Repository
- dismissSessionRepository - Dismiss Failed Session Repository
- push - Push Session to GitHub
- createOrUpdatePullRequest - Create or Update Pull Request
Session
- getPendingInvitation - Find an unfinished invitation for the signed-in recipient
- exchangeSessionToken - Exchange a live session for a delegated access token
Tracking.Experiments
Tracking.Runs
- create - Create
- get - Get
- search - Search
- update - Update
- delete - Delete
- restore - Restore
- logMetric - LogMetric
- logParameter - LogParameter
- setTag - SetTag
- deleteTag - DeleteTag
- logBatch - LogBatch
- logInputs - LogInputs
- getMetricHistory - GetMetricHistory
Usage
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
agentConnectorsActivateAgentConnector- Activate a connectoragentConnectorsCreateAgentConnector- Create a connectoragentConnectorsDeleteAgentConnector- Delete a connectoragentConnectorsGetAgentConnector- Retrieve a connectoragentConnectorsListAgentConnectors- List connectors for an agentagentConnectorsSetupWhatsAppAppWebhook- Set up a WhatsApp app webhook (Beta)agentRunsCreateAgentRun- Start a saved agent runagentRunsDecideAgentRunMcpApproval- Approve or deny a pending MCP tool callagentRunsGetAgentRun- Retrieve an agent runagentRunsListAgentRuns- List runs for an agentagentRunsStreamAgentRunEvents- Stream agent run eventsagentRunsWakeAgentRun- Wake a sleeping agent runagentSchedulesCreateAgentSchedule- Create an agent scheduleagentSchedulesDeleteAgentSchedule- Delete an agent scheduleagentSchedulesGetAgentSchedule- Retrieve an agent scheduleagentSchedulesListAgentSchedules- List schedules for an agentagentSchedulesPauseAgentSchedule- Pause an agent scheduleagentSchedulesResumeAgentSchedule- Resume an agent scheduleagentSchedulesUpdateAgentSchedule- Update an agent scheduleagentsCreateAgent- Create an agentagentsDeleteAgent- Delete an agentagentsGetAgent- Retrieve an agentagentsListAgents- List agentsagentsUpdateAgent- Update an agentagentVersionsGetAgentVersion- Retrieve an agent versionagentVersionsListAgentVersions- List agent versionsagentVersionsRollbackAgentVersion- Roll back an agent to a versionanalyticsCapture- Durably accept a batch of eventsanalyticsEventsSearch- Search events in a time rangeanalyticsKeysCreate- Create a capture key and return its secret onceanalyticsKeysList- List capture key metadataanalyticsKeysRevoke- Revoke a capture keyanalyticsProjectsArchive- Archive an analytics projectanalyticsProjectsCreate- Create an analytics projectanalyticsProjectsGet- Get an analytics projectanalyticsProjectsList- List accessible analytics projectsanalyticsProjectsUpdate- Rename an active analytics projectanalyticsQuery- Query event counts or unique visitorsanalyticsVisitorsSearch- Search visitors in a time rangeauthApiKeysCreate- Mint a scoped API keyauthApiKeysExchangeToken- Exchange API key for a JWT tokenauthApiKeysList- List scoped API keysauthApiKeysRegenerate- Rotate a scoped API key's secretauthApiKeysUpdate- Update a scoped API keyauthClusterAcceptInvite- Accept a cluster invitation (public)authClusterCreateInvite- Create a cluster invitationauthClusterDeleteOrg- Soft-delete an organizationauthClusterGetOrg- Get an organizationauthClusterInviteInfo- Read cluster-invite info (public)authClusterInviteOrgMembers- Invite members on behalf of an organizationauthClusterListInvites- List cluster invitationsauthClusterListOrgs- List all organizationsauthClusterReissueOwnerKey- Re-issue an org owner key (recovery)authClusterRevokeInvite- Revoke a cluster invitationauthClusterSuspendOrg- Suspend an organizationauthClusterUnsuspendOrg- Unsuspend an organizationauthClusterUpdateInvite- Update a pending cluster invitationauthOrgsGetById- Get basic organization detailsauthOrgsGetQuota- Get an org's usage quotaauthOrgsGetRateLimit- Get an org's rate limitauthOrgsUpdate- Patch organization metadata (cluster-admin)authOrgsUpdateQuota- Set an org's usage quota (cluster-admin)authOrgsUpdateRateLimit- Set an org's rate limit (cluster-admin)authServiceAccountsCreate- Create a service accountauthServiceAccountsDelete- Delete a service accountauthServiceAccountsDeleteApiKey- Delete a service-account API keyauthServiceAccountsGet- Get a service accountauthServiceAccountsList- List service accountsauthServiceAccountsListApiKeys- List a service account's API keysauthServiceAccountsRegenerateApiKey- Rotate a service-account API key's secretauthServiceAccountsUpdateApiKey- Update a service-account API keyauthTeamsAddMember- Add a team memberauthTeamsCreate- Create a teamauthTeamsDelete- Delete a teamauthTeamsGet- Get a teamauthTeamsList- List teams in an orgauthTeamsListMembers- List team membersauthTeamsRemoveMember- Remove a team memberauthTeamsUpdate- Rename a teambudgetsApiKeyEvents- List apikey budget eventsbudgetsDeleteApiKey- Delete an apikey budgetbudgetsDeleteExternalUser- Delete a external user budgetbudgetsDeleteExternalUserDefault- Delete a per-external user default budgetbudgetsDeleteOrg- Delete an org budgetbudgetsDeleteTeam- Delete a team budgetbudgetsDeleteTeamDefault- Delete a per-team default budgetbudgetsDeleteUser- Delete a user budgetbudgetsDeleteUserDefault- Delete a per-user default budgetbudgetsExternalUserDefaultEvents- List per-external user default budget eventsbudgetsExternalUserEvents- List external user budget eventsbudgetsGetApiKey- List apikey budgetsbudgetsGetCurrency- Get display currencybudgetsGetExternalUser- List external user budgetsbudgetsGetExternalUserDefault- List per-external user default budgetsbudgetsGetOrg- List org budgetsbudgetsGetTeam- List team budgetsbudgetsGetTeamDefault- List per-team default budgetsbudgetsGetUser- List user budgetsbudgetsGetUserDefault- List per-user default budgetsbudgetsList- List budgetsbudgetsOrgEvents- List org budget eventsbudgetsSetApiKey- Set an apikey budgetbudgetsSetCurrency- Set display currencybudgetsSetExternalUser- Set a external user budgetbudgetsSetExternalUserDefault- Set a per-external user default budgetbudgetsSetOrg- Set an org budgetbudgetsSetTeam- Set a team budgetbudgetsSetTeamDefault- Set a per-team default budgetbudgetsSetUser- Set a user budgetbudgetsSetUserDefault- Set a per-user default budgetbudgetsTeamDefaultEvents- List per-team default budget eventsbudgetsTeamEvents- List team budget eventsbudgetsUserDefaultEvents- List per-user default budget eventsbudgetsUserEvents- List user budget eventscomputeCatalogCreateComputeQuote- Create a quotecomputeCatalogGetAccelerator- Get an acceleratorcomputeCatalogListAccelerators- List acceleratorscomputeCatalogListComputeOffers- List provider offerscomputeCatalogListComputeProviders- List provider healthcomputeJobsCreateJob- Create a jobcomputeJobsGetJob- Get a jobcomputeJobsListJobEvents- List job eventscomputeJobsListJobInstances- List observed job instancescomputeJobsListJobLogs- List job logscomputeJobsListJobs- List jobs- [
computeJobsTerminateJob](docs/sdks/computejobs/README.md#terminatejo
