Skip to content

CMS

Tables of content your sites and apps read.

Open CMS
Checked against the dashboard on November 18, 2026

A CMS table is an ordinary table in the workspace's database. You manage tables with the CMS methods, and you read and write their records with the record methods. Every call is a POST to /cpi/<method> with a JSON body that carries your API key.

bash
curl -X POST https://xuda.ai/cpi/get_cms_tables \
  -H 'content-type: application/json' \
  -d '{"api_key": "YOUR_API_KEY", "workspace_id": "YOUR_WORKSPACE_ID"}'

The answer holds each table with its fields and record count, and the database it lives in (the app_id the record methods take).

From the dashboard

Every table has an API window: press API and JSON on a card or in an open table. It shows the five record calls for that table, the table's own fields as JSON, the same request as cURL or JavaScript, and a place to send it. Its key picker lists the keys that reach the workspace, and can make a new one. A key with full access works. A custom one needs dbs_read to read and dbs_create, dbs_update and dbs_delete to write.

Records

The window's five calls run these methods. Each takes the workspace database's app_id and the table's id.

A record is an object whose keys are the table's field ids. Send table_data as an array to add several records at once. Delete moves records to Archived, and dbs_restore with the same ids brings them back. Add permanent to delete them for good.

POST/cpi/dbs_read
user_access

DBS Read

Reads records from an app table with optional row range, single-row lookup, sorting, filtering, and archived-record selection.

POST/cpi/dbs_create
admin

DBS Create

Creates a new record in the specified app table from the provided key-value table data.

POST/cpi/dbs_update
admin

DBS Update

Replaces the data of an existing record, identified by row_id, in the specified app table.

POST/cpi/dbs_delete
admin

DBS Delete

Soft-deletes (or permanently deletes when 'permanent' is set) the listed record IDs from an app table.

POST/cpi/dbs_restore
admin

DBS Restore

Restores previously soft-deleted records, identified by their IDs, in the specified app table.

Tables

POST/cpi/get_cms_tables
user

Get CMS Tables

The CMS tables of one workspace, active and archived, each with its fields and how many records it holds, plus the database the records live in (the app_id to hand dbs_read, dbs_create, dbs_update, dbs_delete and dbs_restore), whether that database is ready, and the plan with what it allows. The first open of a workspace other than Main installs the database plugin there and answers preparing until it is ready.

POST/cpi/get_cms_table
user

Get CMS Table

One CMS table as Xuda Studio stores it (its fields and indexes), with its record count and the database it lives in.

POST/cpi/save_cms_table
user

Save CMS Table

Create a CMS table, or change one when table_id is sent. A table has a name, an optional description and its fields, each a name, a type (string, number, boolean, date, array, object, or relation) and whether it is required. A relation field relates the table to the Contacts module ({ kind: 'module', module: 'contacts' }) or to another CMS table of the workspace ({ kind: 'table', table_id }), holding one id or, with many, several; a saved relation keeps what it relates to and its shape. Field names start with a letter and use letters, digits and underscores. A new table counts against the plan's tables, and every table against its fields per table. The table is an ordinary Xuda Studio table in the workspace's database, so it opens in Studio too.

POST/cpi/archive_cms_table
user

Archive CMS Table

Archive a CMS table (it leaves the list and its records stay) or bring it back with archived false, which counts against the plan's tables again.

POST/cpi/cms_related_records
user

Get CMS Records Of An Item

The CMS tables related to one item of another module (a ticket, a delivery, an order, a product, a finance document or a contact), each with its fields and the records that point at that item, so the item can show them to fill. A workspace with CMS switched off answers no tables.

A new table counts against your plan's tables, every table against its fields, and adding or restoring records against its records. A call past a limit is refused with a message that says which one.

How is this guide?

Last updated on November 12, 2026