Engine

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200

Success: List of engines

application/json

503

Message: unable to fetch engines from external service

get

/api/v1/engine/

HTTPcURLJavaScriptPython

GET /api/v1/engine/ HTTP/1.1
Host: /
Accept: */*

{
  "engines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "latest_job_status": "STARTED",
      "connector_type": "text",
      "source_database_status": "CURRENT"
    }
  ]
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Responses

200Success

application/json

503

Message: unable to fetch engine from external service

get

/api/v1/engine/{engine_id}/

HTTPcURLJavaScriptPython

GET /api/v1/engine/{engine_id}/ HTTP/1.1
Host: /
Accept: */*

{
  "seed_value": 1,
  "use_seed": true,
  "pii_model_settings": {},
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "n_parallel_pipeline_processes": 1,
  "default_n_training_rows": 1,
  "default_read_random_subset": true,
  "default_sample_noise_ratio": 1,
  "default_max_n_feat_per_model": 1,
  "default_feat_model_train_order": "text",
  "default_max_sequence_length": 1,
  "default_end_of_sequence_token": 1,
  "default_cardinality_threshold": 1,
  "default_rare_category_replacement": "text",
  "default_clip_threshold": 1,
  "default_locale": "en",
  "default_pii_mock_replace": true,
  "default_noise_factor": 1,
  "default_text_processor_model_settings": {},
  "default_textpii_parallel_jobs": 1,
  "default_textpii_scan_batch_size": 1,
  "default_cutoff_length": 1,
  "default_long_sequence_threshold": 1,
  "default_min_sample_size": 1,
  "default_fast_executemany": true,
  "default_consistent_integer_shuffle_threshold": 1,
  "default_order_by_nr_columns": [],
  "default_max_pending_tasks": 1,
  "default_exclude_tables": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-12-22T22:03:25.907Z",
  "last_updated": "2025-12-22T22:03:25.907Z",
  "source_database": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "engine_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "status": "CURRENT",
    "type": "SOURCE",
    "last_synced_at": "2025-12-22T22:03:25.907Z",
    "source_connector": {
      "hooks_params": {
        "SSHTunnel": {
          "host": "text",
          "port": 1,
          "username": "text",
          "local_port": 1,
          "local_host": "text"
        },
        "SSL": {
          "ca_filename": "text",
          "cert_filename": "text",
          "key_filename": "text",
          "ssl_mode": "text"
        },
        "Kerberos": {
          "principal": "text"
        }
      },
      "is_source": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "database_id": "123e4567-e89b-12d3-a456-426614174000",
      "connector_type": "text",
      "host": "text",
      "database": "text",
      "username": "text",
      "schema_name": "text",
      "port": 1433,
      "protocol": "mssql+pyodbc",
      "include_views": false
    },
    "target_connector": {
      "hooks_params": {
        "SSHTunnel": {
          "host": "text",
          "port": 1,
          "username": "text",
          "local_port": 1,
          "local_host": "text"
        },
        "SSL": {
          "ca_filename": "text",
          "cert_filename": "text",
          "key_filename": "text",
          "ssl_mode": "text"
        },
        "Kerberos": {
          "principal": "text"
        }
      },
      "is_source": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "database_id": "123e4567-e89b-12d3-a456-426614174000",
      "connector_type": "text",
      "host": "text",
      "database": "text",
      "username": "text",
      "schema_name": "text",
      "port": 1433,
      "protocol": "mssql+pyodbc",
      "include_views": false
    }
  },
  "target_database": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "engine_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "status": "CURRENT",
    "type": "SOURCE",
    "last_synced_at": "2025-12-22T22:03:25.907Z",
    "source_connector": {
      "hooks_params": {
        "SSHTunnel": {
          "host": "text",
          "port": 1,
          "username": "text",
          "local_port": 1,
          "local_host": "text"
        },
        "SSL": {
          "ca_filename": "text",
          "cert_filename": "text",
          "key_filename": "text",
          "ssl_mode": "text"
        },
        "Kerberos": {
          "principal": "text"
        }
      },
      "is_source": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "database_id": "123e4567-e89b-12d3-a456-426614174000",
      "connector_type": "text",
      "host": "text",
      "database": "text",
      "username": "text",
      "schema_name": "text",
      "port": 1433,
      "protocol": "mssql+pyodbc",
      "include_views": false
    },
    "target_connector": {
      "hooks_params": {
        "SSHTunnel": {
          "host": "text",
          "port": 1,
          "username": "text",
          "local_port": 1,
          "local_host": "text"
        },
        "SSL": {
          "ca_filename": "text",
          "cert_filename": "text",
          "key_filename": "text",
          "ssl_mode": "text"
        },
        "Kerberos": {
          "principal": "text"
        }
      },
      "is_source": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "database_id": "123e4567-e89b-12d3-a456-426614174000",
      "connector_type": "text",
      "host": "text",
      "database": "text",
      "username": "text",
      "schema_name": "text",
      "port": 1433,
      "protocol": "mssql+pyodbc",
      "include_views": false
    }
  },
  "workspace_pk": 1
}

delete

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Responses

200Success

application/json

503

Message: unable to delete engine from external service

delete

/api/v1/engine/{engine_id}/delete/

HTTPcURLJavaScriptPython

DELETE /api/v1/engine/{engine_id}/delete/ HTTP/1.1
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text"
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Responses

200Success

application/json

get

/api/v1/engine/{engine_id}/settings/

HTTPcURLJavaScriptPython

GET /api/v1/engine/{engine_id}/settings/ HTTP/1.1
Host: /
Accept: */*

200Success

{
  "seed_value": 1,
  "use_seed": true,
  "pii_model_settings": {},
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "n_parallel_pipeline_processes": 1,
  "default_n_training_rows": 1,
  "default_read_random_subset": true,
  "default_sample_noise_ratio": 1,
  "default_max_n_feat_per_model": 1,
  "default_feat_model_train_order": "text",
  "default_max_sequence_length": 1,
  "default_end_of_sequence_token": 1,
  "default_cardinality_threshold": 1,
  "default_rare_category_replacement": "text",
  "default_clip_threshold": 1,
  "default_locale": "en",
  "default_pii_mock_replace": true,
  "default_noise_factor": 1,
  "default_text_processor_model_settings": {},
  "default_textpii_parallel_jobs": 1,
  "default_textpii_scan_batch_size": 1,
  "default_cutoff_length": 1,
  "default_long_sequence_threshold": 1,
  "default_min_sample_size": 1,
  "default_fast_executemany": true,
  "default_consistent_integer_shuffle_threshold": 1,
  "default_order_by_nr_columns": [],
  "default_max_pending_tasks": 1,
  "default_exclude_tables": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "set_defaults": true
}

put

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Body

application/json

seed_valueany ofOptionalDefault: null

integerOptional

or

nullOptional

use_seedany ofOptionalDefault: null

booleanOptional

or

nullOptional

pii_model_settingsany ofOptionalDefault: null

objectOptional

or

nullOptional

initialization_modeany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

key_generation_methodany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

n_parallel_pipeline_processesany ofOptionalDefault: null

integerOptional

or

nullOptional

default_n_training_rowsany ofOptionalDefault: null

integerOptional

or

nullOptional

default_read_random_subsetany ofOptionalDefault: null

booleanOptional

or

nullOptional

default_sample_noise_ratioany ofOptionalDefault: null

numberOptional

or

nullOptional

default_max_n_feat_per_modelany ofOptionalDefault: null

integerOptional

or

nullOptional

default_feat_model_train_orderany ofOptionalDefault: null

stringOptional

or

nullOptional

default_max_sequence_lengthany ofOptionalDefault: null

integerOptional

or

nullOptional

default_end_of_sequence_tokenany ofOptionalDefault: null

numberOptional

or

nullOptional

default_cardinality_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

default_rare_category_replacementany ofOptionalDefault: null

stringOptional

or

nullOptional

default_clip_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

default_localeany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

default_pii_mock_replaceany ofOptionalDefault: null

booleanOptional

or

nullOptional

default_noise_factorany ofOptionalDefault: null

numberOptional

or

nullOptional

default_text_processor_model_settingsany ofOptionalDefault: null

objectOptional

or

nullOptional

default_textpii_parallel_jobsany ofOptionalDefault: null

integerOptional

or

nullOptional

default_textpii_scan_batch_sizeany ofOptionalDefault: null

integerOptional

or

nullOptional

default_cutoff_lengthany ofOptionalDefault: null

integerOptional

or

nullOptional

default_long_sequence_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

default_min_sample_sizeany ofOptionalDefault: null

integerOptional

or

nullOptional

default_fast_executemanyany ofOptionalDefault: null

booleanOptional

or

nullOptional

default_consistent_integer_shuffle_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

default_order_by_nr_columnsany ofOptionalDefault: null

or

nullOptional

default_max_pending_tasksany ofOptionalDefault: null

integerOptional

or

nullOptional

default_exclude_tablesany ofOptionalDefault: false

booleanOptional

or

nullOptional

idstring · uuidRequired

set_defaultsany ofOptionalDefault: true

booleanOptional

or

nullOptional

Responses

200Success

application/json

put

/api/v1/engine/{engine_id}/update-settings/

HTTPcURLJavaScriptPython

PUT /api/v1/engine/{engine_id}/update-settings/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1018

{
  "seed_value": 1,
  "use_seed": true,
  "pii_model_settings": {},
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "n_parallel_pipeline_processes": 1,
  "default_n_training_rows": 1,
  "default_read_random_subset": true,
  "default_sample_noise_ratio": 1,
  "default_max_n_feat_per_model": 1,
  "default_feat_model_train_order": "text",
  "default_max_sequence_length": 1,
  "default_end_of_sequence_token": 1,
  "default_cardinality_threshold": 1,
  "default_rare_category_replacement": "text",
  "default_clip_threshold": 1,
  "default_locale": "en",
  "default_pii_mock_replace": true,
  "default_noise_factor": 1,
  "default_text_processor_model_settings": {},
  "default_textpii_parallel_jobs": 1,
  "default_textpii_scan_batch_size": 1,
  "default_cutoff_length": 1,
  "default_long_sequence_threshold": 1,
  "default_min_sample_size": 1,
  "default_fast_executemany": true,
  "default_consistent_integer_shuffle_threshold": 1,
  "default_order_by_nr_columns": [],
  "default_max_pending_tasks": 1,
  "default_exclude_tables": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "set_defaults": true
}

200Success

{
  "seed_value": 1,
  "use_seed": true,
  "pii_model_settings": {},
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "n_parallel_pipeline_processes": 1,
  "default_n_training_rows": 1,
  "default_read_random_subset": true,
  "default_sample_noise_ratio": 1,
  "default_max_n_feat_per_model": 1,
  "default_feat_model_train_order": "text",
  "default_max_sequence_length": 1,
  "default_end_of_sequence_token": 1,
  "default_cardinality_threshold": 1,
  "default_rare_category_replacement": "text",
  "default_clip_threshold": 1,
  "default_locale": "en",
  "default_pii_mock_replace": true,
  "default_noise_factor": 1,
  "default_text_processor_model_settings": {},
  "default_textpii_parallel_jobs": 1,
  "default_textpii_scan_batch_size": 1,
  "default_cutoff_length": 1,
  "default_long_sequence_threshold": 1,
  "default_min_sample_size": 1,
  "default_fast_executemany": true,
  "default_consistent_integer_shuffle_threshold": 1,
  "default_order_by_nr_columns": [],
  "default_max_pending_tasks": 1,
  "default_exclude_tables": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "set_defaults": true
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200

Success: Initialization modes

application/json

get

/api/v1/engine/initialization_modes/

HTTPcURLJavaScriptPython

GET /api/v1/engine/initialization_modes/ HTTP/1.1
Host: /
Accept: */*

200

Success: Initialization modes

{
  "initialization_modes": [
    {
      "name": "SYNTHESIZE",
      "key_generation_method": {
        "available": [
          "duplicate"
        ],
        "default": "duplicate"
      },
      "default_locale": {
        "available": [
          "duplicate"
        ],
        "default": "duplicate"
      }
    }
  ]
}