#!/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-openapi', {
    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 execution events and block spans for a single execution by ID

Get execution events

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 or updates an existing one if a login with the same username, email, or phone number already exists in the organization

Create or 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

Stop execution

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

Creates a new instructor session for a workflow and login

Create instructor session

Stops an instructor session for a workflow and login

Stop instructor session

Executes a single block by ID within an instructor execution context

Authentication

Logins

Executions

Browser Sessions

Workflows

Instructor

API Reference

Get execution events

Body

Response