Skip to main content
POST
/
sandbox
/
snowflake
/
{sandbox_id}
/
initialize
Initialize snowflake sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/snowflake/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "databases": [
    {
      "name": "SANDBOX_DB",
      "description": "Main sandbox database for testing and development",
      "schemas": [
        {
          "name": "SALES",
          "tables": [
            {
              "name": "CUSTOMERS",
              "columns": [
                {
                  "name": "CUSTOMER_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "FIRST_NAME",
                  "data_type": "VARCHAR(100)",
                  "nullable": false
                },
                {
                  "name": "LAST_NAME",
                  "data_type": "VARCHAR(100)",
                  "nullable": false
                },
                {
                  "name": "EMAIL",
                  "data_type": "VARCHAR(255)",
                  "nullable": false
                },
                {
                  "name": "COUNTRY",
                  "data_type": "VARCHAR(100)",
                  "nullable": true
                },
                {
                  "name": "CREATED_AT",
                  "data_type": "TIMESTAMP_NTZ(9)",
                  "nullable": true,
                  "default_value": "CURRENT_TIMESTAMP()"
                }
              ],
              "rows": [
                {
                  "values": {
                    "CUSTOMER_ID": 1,
                    "FIRST_NAME": "John",
                    "LAST_NAME": "Doe",
                    "EMAIL": "john.doe@example.com",
                    "COUNTRY": "USA",
                    "CREATED_AT": "2024-01-15T09:00:00"
                  }
                },
                {
                  "values": {
                    "CUSTOMER_ID": 2,
                    "FIRST_NAME": "Jane",
                    "LAST_NAME": "Smith",
                    "EMAIL": "jane.smith@example.com",
                    "COUNTRY": "Canada",
                    "CREATED_AT": "2024-01-15T09:05:00"
                  }
                },
                {
                  "values": {
                    "CUSTOMER_ID": 3,
                    "FIRST_NAME": "Bob",
                    "LAST_NAME": "Johnson",
                    "EMAIL": "bob.johnson@example.com",
                    "COUNTRY": "UK",
                    "CREATED_AT": "2024-01-15T09:10:00"
                  }
                },
                {
                  "values": {
                    "CUSTOMER_ID": 4,
                    "FIRST_NAME": "Alice",
                    "LAST_NAME": "Williams",
                    "EMAIL": "alice.williams@example.com",
                    "COUNTRY": "Australia",
                    "CREATED_AT": "2024-01-15T09:15:00"
                  }
                }
              ]
            },
            {
              "name": "ORDERS",
              "columns": [
                {
                  "name": "ORDER_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "CUSTOMER_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "ORDER_DATE",
                  "data_type": "DATE",
                  "nullable": false
                },
                {
                  "name": "TOTAL_AMOUNT",
                  "data_type": "NUMBER(10,2)",
                  "nullable": false
                },
                {
                  "name": "STATUS",
                  "data_type": "VARCHAR(50)",
                  "nullable": false
                }
              ],
              "rows": [
                {
                  "values": {
                    "ORDER_ID": 1001,
                    "CUSTOMER_ID": 1,
                    "ORDER_DATE": "2024-01-15",
                    "TOTAL_AMOUNT": "250.50",
                    "STATUS": "COMPLETED"
                  }
                },
                {
                  "values": {
                    "ORDER_ID": 1002,
                    "CUSTOMER_ID": 2,
                    "ORDER_DATE": "2024-01-16",
                    "TOTAL_AMOUNT": "175.25",
                    "STATUS": "SHIPPED"
                  }
                },
                {
                  "values": {
                    "ORDER_ID": 1003,
                    "CUSTOMER_ID": 1,
                    "ORDER_DATE": "2024-01-17",
                    "TOTAL_AMOUNT": "399.99",
                    "STATUS": "PROCESSING"
                  }
                },
                {
                  "values": {
                    "ORDER_ID": 1004,
                    "CUSTOMER_ID": 3,
                    "ORDER_DATE": "2024-01-18",
                    "TOTAL_AMOUNT": "89.99",
                    "STATUS": "COMPLETED"
                  }
                },
                {
                  "values": {
                    "ORDER_ID": 1005,
                    "CUSTOMER_ID": 4,
                    "ORDER_DATE": "2024-01-19",
                    "TOTAL_AMOUNT": "450.00",
                    "STATUS": "PENDING"
                  }
                }
              ]
            },
            {
              "name": "PRODUCTS",
              "columns": [
                {
                  "name": "PRODUCT_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "PRODUCT_NAME",
                  "data_type": "VARCHAR(200)",
                  "nullable": false
                },
                {
                  "name": "CATEGORY",
                  "data_type": "VARCHAR(100)",
                  "nullable": true
                },
                {
                  "name": "PRICE",
                  "data_type": "NUMBER(10,2)",
                  "nullable": false
                },
                {
                  "name": "IN_STOCK",
                  "data_type": "BOOLEAN",
                  "nullable": false,
                  "default_value": "TRUE"
                }
              ],
              "rows": [
                {
                  "values": {
                    "PRODUCT_ID": 101,
                    "PRODUCT_NAME": "Laptop Pro 15",
                    "CATEGORY": "Electronics",
                    "PRICE": "1299.99",
                    "IN_STOCK": true
                  }
                },
                {
                  "values": {
                    "PRODUCT_ID": 102,
                    "PRODUCT_NAME": "Wireless Mouse",
                    "CATEGORY": "Electronics",
                    "PRICE": "29.99",
                    "IN_STOCK": true
                  }
                },
                {
                  "values": {
                    "PRODUCT_ID": 103,
                    "PRODUCT_NAME": "Office Chair",
                    "CATEGORY": "Furniture",
                    "PRICE": "249.99",
                    "IN_STOCK": false
                  }
                },
                {
                  "values": {
                    "PRODUCT_ID": 104,
                    "PRODUCT_NAME": "Desk Lamp",
                    "CATEGORY": "Furniture",
                    "PRICE": "45.00",
                    "IN_STOCK": true
                  }
                }
              ]
            }
          ]
        },
        {
          "name": "ANALYTICS",
          "tables": [
            {
              "name": "SALES_METRICS",
              "columns": [
                {
                  "name": "METRIC_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "METRIC_DATE",
                  "data_type": "DATE",
                  "nullable": false
                },
                {
                  "name": "REVENUE",
                  "data_type": "NUMBER(12,2)",
                  "nullable": false
                },
                {
                  "name": "ORDERS_COUNT",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "AVG_ORDER_VALUE",
                  "data_type": "NUMBER(10,2)",
                  "nullable": false
                }
              ],
              "rows": [
                {
                  "values": {
                    "METRIC_ID": 1,
                    "METRIC_DATE": "2024-01-15",
                    "REVENUE": "250.50",
                    "ORDERS_COUNT": 1,
                    "AVG_ORDER_VALUE": "250.50"
                  }
                },
                {
                  "values": {
                    "METRIC_ID": 2,
                    "METRIC_DATE": "2024-01-16",
                    "REVENUE": "175.25",
                    "ORDERS_COUNT": 1,
                    "AVG_ORDER_VALUE": "175.25"
                  }
                },
                {
                  "values": {
                    "METRIC_ID": 3,
                    "METRIC_DATE": "2024-01-17",
                    "REVENUE": "399.99",
                    "ORDERS_COUNT": 1,
                    "AVG_ORDER_VALUE": "399.99"
                  }
                }
              ]
            },
            {
              "name": "USER_ACTIVITY",
              "columns": [
                {
                  "name": "ACTIVITY_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "USER_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "ACTIVITY_TYPE",
                  "data_type": "VARCHAR(100)",
                  "nullable": false
                },
                {
                  "name": "ACTIVITY_TIMESTAMP",
                  "data_type": "TIMESTAMP_NTZ(9)",
                  "nullable": false
                },
                {
                  "name": "METADATA",
                  "data_type": "VARIANT",
                  "nullable": true
                }
              ],
              "rows": [
                {
                  "values": {
                    "ACTIVITY_ID": 1,
                    "USER_ID": 1,
                    "ACTIVITY_TYPE": "LOGIN",
                    "ACTIVITY_TIMESTAMP": "2024-01-15T08:30:00"
                  }
                },
                {
                  "values": {
                    "ACTIVITY_ID": 2,
                    "USER_ID": 1,
                    "ACTIVITY_TYPE": "PURCHASE",
                    "ACTIVITY_TIMESTAMP": "2024-01-15T10:45:00"
                  }
                },
                {
                  "values": {
                    "ACTIVITY_ID": 3,
                    "USER_ID": 2,
                    "ACTIVITY_TYPE": "LOGIN",
                    "ACTIVITY_TIMESTAMP": "2024-01-16T09:15:00"
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "name": "TEST_DB",
      "description": "Secondary database for integration testing",
      "schemas": [
        {
          "name": "OBSERVATION",
          "tables": [
            {
              "name": "TEST_LOGS",
              "columns": [
                {
                  "name": "LOG_ID",
                  "data_type": "NUMBER(38,0)",
                  "nullable": false
                },
                {
                  "name": "LOG_MESSAGE",
                  "data_type": "VARCHAR(1000)",
                  "nullable": false
                },
                {
                  "name": "LOG_LEVEL",
                  "data_type": "VARCHAR(20)",
                  "nullable": false
                },
                {
                  "name": "CREATED_AT",
                  "data_type": "TIMESTAMP_NTZ(9)",
                  "nullable": false
                }
              ],
              "rows": [
                {
                  "values": {
                    "LOG_ID": 1,
                    "LOG_MESSAGE": "Application started successfully",
                    "LOG_LEVEL": "INFO",
                    "CREATED_AT": "2024-01-15T08:00:00"
                  }
                },
                {
                  "values": {
                    "LOG_ID": 2,
                    "LOG_MESSAGE": "Database connection established",
                    "LOG_LEVEL": "INFO",
                    "CREATED_AT": "2024-01-15T08:00:05"
                  }
                },
                {
                  "values": {
                    "LOG_ID": 3,
                    "LOG_MESSAGE": "Warning: High memory usage detected",
                    "LOG_LEVEL": "WARNING",
                    "CREATED_AT": "2024-01-15T10:30:00"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

​
Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

​
sandbox_id
string
required

The unique sandbox identifier

Query Parameters

​
init_default_data
boolean
default:false

If true, use default test data for initialization

Body

application/json

Complete Snowflake sandbox data structure.

Hierarchical structure for initialization:

  • Databases contain Schemas
  • Schemas contain Tables
  • Tables contain Columns and Rows
​
databases
SnowflakeDatabase · object[]

List of databases with their schemas

Response

Successful Response

Response model for sandbox initialization

​
sandbox_id
string
required

Sandbox identifier

​
status
enum<string>
required

Current status

Available options:
idle,
occupied,
error
​
message
string
required

Initialization result message

​
records_created
Records Created · object

Count of records created per object type