Workbooks

📓 Workbooks

Workbooks are interactive documents within a Workspace where you can perform data analysis, visualization, and modeling. You can create multiple workbooks to organize different projects or analyses.

Create Table in Workspace

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables

Initializes a new table within a specific workspace. You can optionally include columns in the same request.

Query Parameters

• isIncludeColumns (optional): Set to true to return column details in response.

Example cURL

curl --location 'https://{{base_url}}/noCo/api/v2/workspaces/{{workspace_id}}/tables?isIncludeColumns=true' \
--header 'x-auth-token: {{token}}'

Get Table Schema

GEThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId

Retrieves the structure, constraints, and column definitions of a specific table.

Example cURL

curl --location 'https://{{base_url}}/noCo/api/v2/workspaces/{{workspace_id}}/tables/{{table_id}}' \
--header 'x-auth-token: {{token}}'

Get Table Data

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/data/external

Fetches rows from a table with support for complex filtering, sorting, and pagination.

Request Body (JSON)

Field	Type	Required	Description	Example
requestPageDetails	object	No	Pagination settings (pageNumber, pageSize)	{"pageNumber": 1, "pageSize": 500}
whereClause	string	No	SQL-like filter condition. Dates must be in YYYY-MM-DD format.	(`first_name` like '%d%' and `years_of_experience` > 4)
sortOptions	array	No	List of sorting rules	[{"columnName": "first_name", "direction": "DESC"}]

Try it out

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/data/external

Request Body (JSON)

{ "requestPageDetails": { "pageNumber": 1, "pageSize": 500 }, "sortOptions": [ { "columnName": "first_name", "direction": "DESC" } ], "whereClause": "(`first_name` like '%d%' and `years_of_experience` > 4 and `start_date` between '2004-01-01' and '2009-12-31' and `is_active` = true)" }

Get Row by ID

GEThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows/:rowId

Retrieves a single record by its internal unique identifier.

Try it out

GEThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows/1

---

📊 Column Data Types

When creating columns, use the following uiDataType values to define the behavior and validation of your data.

uiDataType	Description	Example Value
SINGLE_LINE_TEXT	Short text values.	"Jane Doe"
LONG_TEXT	Multi-line text or descriptions.	"This is a long description..."
NUMBER	Numeric values (integer/decimal).	1250.50
DATE	Calendar dates.	"2025-12-31"
CHECKBOX	Boolean true/false values.	true
FORMULA	Calculated values using SQL syntax.	price * quantity
SINGLE_SELECT	One value from a predefined list.	"Active"

---

Create Column

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/column

Adds a new column to a table. Supports various data types including Standard and Formula columns.

Standard Column

{
    "uiDataType": "SINGLE_LINE_TEXT",
    "uiMetadata": {
        "title": "Contact Name"
    },
    "name": "contact_name"
}

Formula Column

{
    "uiDataType": "FORMULA",
    "uiMetadata": {
        "title": "sample demo formula"
    },
    "formula": "length(name)",
    "formulaType": "SQL",
    "name": "sample_demo_formula"
}

AI Generated Column

{
    "uiDataType": "SINGLE_LINE_TEXT",
    "name": "ai_summary",
    "description": "Auto-generated summary",
    "uiMetadata": {
        "title": "AI Summary"
    },
    "required": false,
    "settings": {
        "aiSettings": {
            "enabled": true,
            "prompt": "Summarize the 'description' field in 10 words",
            "model": "gpt-4o-mini",
            "webAccess": false
        }
    }
}

🛠️ How to Enable AI Features

To turn a standard column into an AI-powered one, you must include the settings.aiSettings object in your request:

• enabled: Set to true to activate AI processing.
• prompt: The "instruction" for the AI (e.g., "Summarize this row").
• model: Choose between gpt-4o-mini or gpt-4o.
• webAccess: (Optional) Set to true if the AI needs to browse the internet to find information.

Note: AI columns automatically re-process whenever the source fields they depend on are updated.

Try it out

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/column

Request Body (JSON)

{ "uiDataType": "FORMULA", "uiMetadata": { "title": "sample demo formula" }, "formula": "length(name)", "formulaType": "SQL", "name": "sample_demo_formula" }

Update Column

PUThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/columns/:columnId

Updates an existing column's definition, such as its title, description, or data type settings.

Request Body (JSON)

{
    "name": "updated_column_name",
    "uiDataType": "SINGLE_LINE_TEXT",
    "uiMetadata": {
        "title": "New Column Title"
    }
}

Try it out

PUThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/columns/:columnId

Request Body (JSON)

{ "name": "question", "uiDataType": "SINGLE_LINE_TEXT", "uiMetadata": { "title": "Updated Question Title" } }

Delete Column

DELETEhttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/columns/:columnId

Permanently removes a column and all its associated data from the table.

Try it out

DELETEhttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/columns/:columnId

Add Row to Workbook

POSThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows

Inserts a new record into the specified table.

Request Body (JSON)

{
    "cellValues": {
        "name": "Sample Project",
        "status": "In Progress",
        "priority": "High"
    }
}

Update Existing Row

PUThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows

Updates an existing record. You must provide the row id along with the new cellValues.

Request Body (JSON)

{
    "id": 1,
    "cellValues": {
        "name": "Updated Project Name"
    }
}

Try it out

PUThttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows

Request Body (JSON)

{ "id": 1, "cellValues": { "name": "dega" } }

Delete Rows

DELETEhttps://be.datagol.ai/noCo/api/v2/workspaces/:workspaceId/tables/:tableId/rows

Deletes one or more rows from a specific table within a workspace.

Request Body (JSON)

Field	Type	Required	Description	Example
rowIds	array	Yes	List of internal row IDs to delete	[5, 4, 3]

Example Request

{
    "rowIds": [5, 4, 3]
}