Go to Syntho.AI

Workspaces

get

List workspace

Authorizations
sessionidstringRequired

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

Responses
200

Success: Workspace List

application/json
get
/api/v1/workspaces/
GET /api/v1/workspaces/ HTTP/1.1
Host: /
Accept: */*
200

Success: Workspace List

{
  "workspaces": [
    {
      "pk": 1,
      "name": "text",
      "organization": 1,
      "engine_id": "text",
      "owner_name": "text",
      "created_at": "2025-11-27T07:42:00.997Z",
      "status": "text",
      "engine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "latest_job_status": "STARTED",
        "connector_type": "text",
        "source_database_status": "CURRENT"
      },
      "initialization_mode": "SYNTHESIZE",
      "key_generation_method": "duplicate",
      "default_locale": "en"
    }
  ]
}
post

Create a new workspace and engine

Authorizations
sessionidstringRequired

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

Query parameters
sample_dbstringOptional

The sample database to use

Body
initialization_modeany ofOptionalDefault: SCRATCH
string · enumOptionalPossible values:
or
nullOptional
key_generation_methodany ofOptionalDefault: duplicate
string · enumOptionalPossible values:
or
nullOptional
default_localeany ofOptionalDefault: en
string · enumOptionalPossible values:
or
nullOptional
source_connectionone ofRequired
or
or
or
or
or
or
target_connectionone ofRequired
or
or
or
or
or
or
or
or
namestringRequired
organizationintegerRequired
Responses
200

Success: Created workspace

application/json
post
/api/v1/workspaces/
POST /api/v1/workspaces/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1194

{
  "initialization_mode": "SCRATCH",
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1433,
    "protocol": "mssql+pyodbc"
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1433,
    "protocol": "mssql+pyodbc"
  },
  "name": "text",
  "organization": 1
}
{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-11-27T07:42:00.997Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}
get
Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Responses
200Success
application/json
get
/api/v1/workspaces/{id}/
GET /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Accept: */*
200Success
{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-11-27T07:42:00.997Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}
put

Update a workspace and engine

Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Body
source_connectionone ofRequired
or
or
or
or
or
or
target_connectionone ofRequired
or
or
or
or
or
or
or
or
key_generation_methodany ofOptionalDefault: duplicate
string · enumOptionalPossible values:
or
nullOptional
default_localeany ofOptionalDefault: en
string · enumOptionalPossible values:
or
nullOptional
namestringRequired
Responses
200

Success: Created workspace

application/json
put
/api/v1/workspaces/{id}/
PUT /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1123

{
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text"
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text"
  },
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "name": "text"
}
{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-11-27T07:42:00.997Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}
delete

Delete a workspace and cancel workspace creation job.

Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Responses
delete
/api/v1/workspaces/{id}/
DELETE /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Accept: */*
204

No response body

No content
post

Duplicates a workspace, including permissions

Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Body
source_connectionone ofRequired
or
or
or
or
or
or
target_connectionone ofRequired
or
or
or
or
or
or
or
or
key_generation_methodany ofOptionalDefault: duplicate
string · enumOptionalPossible values:
or
nullOptional
default_localeany ofOptionalDefault: en
string · enumOptionalPossible values:
or
nullOptional
namestringRequired
Responses
200

Success: Created workspace

application/json
post
/api/v1/workspaces/{id}/duplicate/
POST /api/v1/workspaces/{id}/duplicate/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1123

{
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text"
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text"
  },
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "name": "text"
}
{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-11-27T07:42:00.997Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}
get
Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Responses
200Success
application/json
get
/api/v1/workspaces/{id}/members/
GET /api/v1/workspaces/{id}/members/ HTTP/1.1
Host: /
Accept: */*
200Success
[
  {
    "pk": 1,
    "workspace": 1,
    "user": {
      "pk": 1,
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "[email protected]"
    },
    "role": "OWNER",
    "data_access": true
  }
]
PreviousWorkspace Permissions

Last updated

Was this helpful?