Get Or Create Table

Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema.

Path Parameters

table*string

The table's name or unique identifier for targeting specific table operations.

Request Body

application/json

Schema defining the structure of the table

TypeScript Definitions

Use the request body type in TypeScript.

factor?number

The 'factor' multiplies the row's data storage limit by 4KB and its quota count. It can only be increased (not decreased) after table creation via updateTable. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.

Range1 <= value <= 30

Default1

frozen?boolean

A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.

keyColumn?|

Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.

schema*

Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.

tags?

Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.

isComputeEnabled?boolean

Indicates if the table is enabled for computation.

Response Body

`application/json`

curl -X POST "https://example.com/v1/tables/string" \  -H "Content-Type: application/json" \  -d '{    "schema": {}  }'

{  "table": {    "id": "string",    "name": "string",    "factor": 1,    "frozen": true,    "keyColumn": "string",    "schema": {      "$schema": "string",      "properties": {        "property1": {          "type": "string",          "format": "date-time",          "description": "string",          "pattern": "string",          "enum": [            "string"          ],          "items": {            "type": "string"          },          "nullable": true,          "properties": {            "property1": {              "type": "string"            },            "property2": {              "type": "string"            }          },          "x-zui": {            "index": 0,            "id": "string",            "searchable": true,            "hidden": true,            "order": 0,            "width": 0,            "schemaId": "string",            "computed": {              "action": "ai",              "dependencies": [],              "prompt": "string",              "code": "string",              "model": "gpt-4o",              "workflowId": "string",              "enabled": true            },            "typings": "string"          }        },        "property2": {          "type": "string",          "format": "date-time",          "description": "string",          "pattern": "string",          "enum": [            "string"          ],          "items": {            "type": "string"          },          "nullable": true,          "properties": {            "property1": {              "type": "string"            },            "property2": {              "type": "string"            }          },          "x-zui": {            "index": 0,            "id": "string",            "searchable": true,            "hidden": true,            "order": 0,            "width": 0,            "schemaId": "string",            "computed": {              "action": "ai",              "dependencies": [],              "prompt": "string",              "code": "string",              "model": "gpt-4o",              "workflowId": "string",              "enabled": true            },            "typings": "string"          }        }      },      "additionalProperties": true,      "required": [        "string"      ],      "type": "object"    },    "tags": {      "property1": "string",      "property2": "string"    },    "isComputeEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "created": true,  "rows": 0,  "stale": 0,  "indexing": 0}

{  "table": {    "id": "string",    "name": "string",    "factor": 1,    "frozen": true,    "keyColumn": "string",    "schema": {      "$schema": "string",      "properties": {        "property1": {          "type": "string",          "format": "date-time",          "description": "string",          "pattern": "string",          "enum": [            "string"          ],          "items": {            "type": "string"          },          "nullable": true,          "properties": {            "property1": {              "type": "string"            },            "property2": {              "type": "string"            }          },          "x-zui": {            "index": 0,            "id": "string",            "searchable": true,            "hidden": true,            "order": 0,            "width": 0,            "schemaId": "string",            "computed": {              "action": "ai",              "dependencies": [],              "prompt": "string",              "code": "string",              "model": "gpt-4o",              "workflowId": "string",              "enabled": true            },            "typings": "string"          }        },        "property2": {          "type": "string",          "format": "date-time",          "description": "string",          "pattern": "string",          "enum": [            "string"          ],          "items": {            "type": "string"          },          "nullable": true,          "properties": {            "property1": {              "type": "string"            },            "property2": {              "type": "string"            }          },          "x-zui": {            "index": 0,            "id": "string",            "searchable": true,            "hidden": true,            "order": 0,            "width": 0,            "schemaId": "string",            "computed": {              "action": "ai",              "dependencies": [],              "prompt": "string",              "code": "string",              "model": "gpt-4o",              "workflowId": "string",              "enabled": true            },            "typings": "string"          }        }      },      "additionalProperties": true,      "required": [        "string"      ],      "type": "object"    },    "tags": {      "property1": "string",      "property2": "string"    },    "isComputeEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "created": true,  "rows": 0,  "stale": 0,  "indexing": 0}

Path Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`