#!/usr/bin/env node

const fs = require('fs');
const path = require('path');
const { execSync } = require('child_process');

// Run the shared-types generate-openapi script
console.log('Running shared-types generate-openapi script...');
try {
  execSync('pnpm --filter @kaizen/shared-types generate-docs', {
    stdio: 'inherit',
    cwd: path.join(__dirname, '../../..'),
  });
  console.log('✅ OpenAPI generation completed successfully');
} catch (error) {
  console.error('❌ Error generating OpenAPI:', error.message);
  process.exit(1);
}

// Path to the OpenAPI file in shared-types
const sharedTypesOpenApiPath = path.join(
  __dirname,
  '../../../packages/shared-types/src/api/openapi/openapi.json'
);

// Path where to copy the OpenAPI file in the docs folder
const docsOpenApiPath = path.join(__dirname, '../openapi.json');

// Copy the OpenAPI file to the docs directory
try {
  console.log('Copying OpenAPI file to docs directory...');
  fs.copyFileSync(sharedTypesOpenApiPath, docsOpenApiPath);
  console.log('✅ OpenAPI file copied successfully');
} catch (error) {
  console.error('❌ Error copying OpenAPI file:', error.message);
  process.exit(1);
}

// Generate MDX files from the OpenAPI document
try {
  console.log('Generating MDX files from OpenAPI document...');
  // Use the local copy of the OpenAPI file
  execSync(
    `npx @mintlify/scraping@latest openapi-file "./openapi.json" -o ./api-reference`,
    {
      stdio: 'inherit',
      cwd: path.join(__dirname, '..'),
    }
  );
  console.log('✅ MDX files generated successfully!');
} catch (error) {
  console.error('❌ Error generating MDX files:', error.message);
  process.exit(1);
}


Retrieves parameter configuration for a workflow

Get workflow parameters

Workflow parameters retrieved successfully

Kaizen

Documentation for the Kaizen Automation API

Introduction

Description of core concepts exposed by the Kaizen Platform.

Core Concepts

Authentication

Verifies a two-factor authentication code for an ongoing authentication session

Submit 2FA code

Creates a new login with required credentials

Create a login

Updates an existing login with optional credentials

Update a login

Delete a login

Retrieves all logins with optional filtering by domain

List logins

Retrieves all executions for the current organization with optional filtering

List executions

Retrieves a single execution by ID for the current organization

Get execution

Retrieves execution events and block spans for a single execution by ID

Get execution events

Stop execution

Create a new environment variable or update an existing one

Create or update environment variable

Delete environment variable

List all environment variables for the organization

List environment variables

Creates a new workflow for the authenticated organization

Create a new workflow

Executes a workflow with the specified login and parameters

Execute a workflow

Executes a workflow with the specified login and parameters and waits for completion

Execute a workflow synchronously

Retrieves all workflows for an organization

List workflows

Retrieves a workflow by ID with its blocks

Get workflow

Updates the blocks of an existing workflow

Update workflow blocks

Sets or updates the parameter schema for a workflow

Set workflow parameter schema

Create workflow schedule

List workflow schedules

Delete workflow schedule

Update workflow schedule

Creates a copy of an existing workflow with the name "{original name} copy"

Duplicate workflow

Delete workflow

Creates parameter configuration for a workflow

Create workflow parameters

Updates parameter configuration for a workflow

Update workflow parameters

Deletes parameter configuration for a workflow

Delete workflow parameters

Creates a new instructor session for a workflow and login

Create instructor session

Creates a new instructor session for a workflow and login, waits until it reaches InProgress or Completed state

Create instructor session (synchronous)

Lists all instructor executions for the authenticated organization

List instructor executions

Stops an instructor session for a workflow and login

Stop instructor session

Starts recording an instructor session for a workflow and login

Start recording instructor session

Stops recording an instructor session for a workflow and login

Stop recording instructor session

Executes a single block by ID or name within an instructor execution context. Provide either blockId or blockName to identify the block.

Authentication

Logins

Executions

Browser Sessions

Environments

Workflows

Workflow Parameters

Instructor

API Reference

Get workflow parameters

Body

Response