Create SQL draft version¶

Creates an editable draft version of a SQL save record and saves the original SQL content.

HTTP
POST $CLOUDSIGMA_API_BASE/workbook/version/create

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First create a saved SQL record to obtain its workbook_id.

$WORKBOOK_ID in the example below is the ID of the SQL saved record. sql_content only saves the SQL content and does not execute the SQL.

Request¶

Replace caller-specific values in the example with actual values.

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/workbook/version/create" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"workbook_id\": \"$WORKBOOK_ID\",
    \"sql_content\": \"SELECT 1\"
  }"

Parameter reference

Request body

Parameter	Type	Required	Description
`workbook_id`	string	Required	The ID of the SQL saved record.
`sql_content`	string		Draft SQL content.

Successful response¶

data.id is the new draft version ID. After saving the ID, you can update draft version or final version.

Response example

JSON
{
  "code": 200,
  "data": {
    "id": "version-123",
    "version": "v1",
    "status": "draft"
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`data.id`	string	New draft version ID.
`data.version`	string	Version name.
`data.status`	string	New version status, which is `draft`.

Error response¶

Response example

JSON
{
  "code": 500,
  "message": "Internal server error"
}

Field reference

Field	Type	Description
`code`	integer or string	Error code or status.
`message`	string	Error message.

Follow-up operations¶

Log data.id. Use this ID View saved SQL version content to confirm the save result.

Last updated on Sep 15, 2026