Get Base Structure

This endpoint provides information about the table's general structure, including its sheet details, columns, and primary column. It allows users to understand the table layout and column configurations for further processing or integration.

Endpoint:

GET https://api.ottogrid.ai/api/v1/bases/{baseId}/base-structure

Headers:

X-API-Key: Your API key

Path Parameters:

• baseId: The ID of the base you want to retrieve the table structure from. This is available in the URL of the table.

Example API Request:

Request:

curl --request GET \ --url 'https://api.ottogrid.ai/api/v1/bases/4w6PXinr/base-structure' \ --header 'X-API-Key: {your-api-key}'

Response:

Standard Response:

{
    "sheet": {
        "id": "sheet_x1mDVsgT4Cdz9Ud6",
        "baseId": "4w6PXinr",
        "name": "Company Table"
    },
    "sheetColumns": [
        {
            "id": "scol_X4oEK17DfhzT2crt",
            "index": 0,
            "inputColumnIds": [],
            "instructions": "Name of the company",
            "isAiEnabled": false,
            "isPrimary": true,
            "name": "Company",
            "tools": [],
            "type": "short-text"
        },
        {
            "id": "scol_a7tGaCQUGxheUUxn",
            "index": 1,
            "inputColumnIds": [
                "scol_X4oEK17DfhzT2crt"
            ],
            "instructions": "URL of the company",
            "isAiEnabled": true,
            "isPrimary": false,
            "name": "Company URL",
            "tools": [
                {
                    "name": "web-search"
                }
            ],
            "type": "url"
        }
    ],
    "primaryColumn": {
            "id": "scol_X4oEK17DfhzT2crt",
            "index": 0,
            "inputColumnIds": [],
            "instructions": "Name of the company",
            "isAiEnabled": false,
            "isPrimary": true,
            "name": "Company",
            "tools": [],
            "type": "short-text"
        },
    }
}

Response Details:

Objects:

• sheet:

  • Contains general information about the sheet, including:

    • id: Unique identifier of the sheet.

    • baseId: ID of the base containing the sheet.

    • name: The name of the sheet.

• sheetColumns:

  • An array of objects, each representing a column in the table.

  • Fields include:

    • id: Unique identifier for the column.

    • index: Position of the column in the table.

    • name: Name of the column as displayed in the table.

    • type: Type of the column (e.g., short-text, email, number).

    • isAiEnabled: Boolean indicating whether AI is enabled for the column.

    • isPrimary: Boolean indicating if the column is the primary column.

    • inputColumnIds: Array of column IDs used as inputs for this column.

    • tools: Array of tools enabled for the column (e.g., web-search, email-enrichment).

    • instructions: Instructions or prompts for AI enrichment.

    • columnOptions: Additional configuration options for the column.

• primaryColumn:

  • Metadata about the table’s primary column, including all fields found in individual sheet columns (e.g., id, name, type).

Notes:

• Primary Column: Each table has one designated primary column (isPrimary: true), which serves as the main entity (e.g., Company Name, Investor Name).

• Input Column IDs: Use the inputColumnIds field to identify dependencies between columns, allowing chaining of data inputs for AI-powered workflows.

• Tools: The tools field lists the enabled tool for each column (e.g., web-search).