Skip to content
LydieDevelopers
Menu

Create a database

View as Markdown
POST/v1/databases

Creates a database: a document whose children are its rows. With documentId, turns an existing document into a database (its children become rows). Starts with a title property and one view.

docs:writeUndoable
Request
curl -X POST "https://api.lydie.co/v1/databases" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA"
  }'

Body

  • workspaceIdstringrequired· 1–64 chars
  • idULID

    Client-minted id of the new database document.

  • documentIdULID

    Turn this existing document into a database.

  • parentIdULIDor null

    Default null

  • titlestring· 1–255 chars

    Default "Untitled database"

  • teamspaceIdstringor null· 1–64 chars

    Hosted: the teamspace a new top-level database goes into (null or absent: the creator's private section). Ignored with parentId or documentId, and in local mode.

  • afterIdULID

    Place directly after this sibling.

  • beforeIdULID

    Place directly before this sibling.

  • sortKeystring· 1–256 chars

    Explicit fractional key (recorded so replays converge).

  • viewTypestring

    One oftableboardlistcalendargallery

    Default "table"

  • titlePropertyIdULID
  • viewIdULID

Response

  • databaseDatabase
    Show 8 fields
  • propertiesDatabaseProperty[]
    Show 13 fields
    • idULID
    • workspaceIdstring· 1–64 chars
    • databaseIdULID
    • namestring· 1–200 chars

      Display name (Bases displayName).

    • typestring

      One oftitletextnumberselectmultiSelectstatusdatecheckboxurlemailphonepersonfilesrelationrollupformulauniqueIdcreatedTimeupdatedTimecreatedByupdatedBy

    • keystring· 1–128 chars

      Stored types: the frontmatter key holding the value. Formulas, rollups, createdBy and updatedBy: the formula name in the .base file. Unused for title and created/updated time.

    • configPropertyConfig
      Show 11 fields
      • optionsSelectOption[]optional

        select, multiSelect, status

        Show 4 fields
        • idULID
        • namestring· 1–200 chars
        • colorstring

          One ofdefaultgraybrownorangeyellowgreenbluepurplepinkred

          Default "default"

        • groupstringoptional

          One oftodoinProgresscomplete

      • numberFormatstringoptional

        One ofnumberintegercommaspercentcurrency

      • decimalsintegeroptional· 0–10
      • currencystringoptional· 3–3 chars

        ISO 4217 code, with numberFormat currency

      • includeTimebooleanoptional

        date: values carry a time

      • rangebooleanoptional

        date: values may carry an end (start/end)

      • relationRelationConfigoptional
        Show 4 fields
        • databaseIdULID

          The database whose rows this relation points at.

        • twoWayboolean

          Default false

        • reversePropertyIdULIDor null

          The synced property on the other database (two-way relations).

          Default null

        • limitstring

          One ofonemany

          Default "many"

      • rollupRollupConfigoptional
        Show 3 fields
        • relationPropertyIdULID
        • targetPropertyIdULID

          A property of the related database.

        • functionstring

          One ofshowOriginalshowUniquecountcountValuescountUniquecountEmptycountNotEmptypercentEmptypercentNotEmptysumaveragemedianminmaxrangeearliestlatestcheckeduncheckedpercentCheckedpercentUnchecked

      • expressionstringoptional

        formula: an Obsidian Bases expression

      • prefixstringoptional· ≤ 16 chars

        uniqueId: shown before the number ("LYD" → LYD-12)

      • extraobjectoptional
    • sortKeystring· 1–256 chars
    • createdAttimestamp
    • updatedAttimestamp
    • deletedAttimestampor null
    • createdBystringor nulloptional· ≥ 1 chars
    • updatedBystringor nulloptional· ≥ 1 chars
  • viewsDatabaseView[]
    Show 12 fields
200
{
  "database": {
    "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
    "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
    "config": {
      "filter": null,
      "templateIds": [],
      "extra": {}
    },
    "createdAt": "2026-11-12T09:30:00.000Z",
    "updatedAt": "2026-11-12T09:30:00.000Z",
    "deletedAt": null,
    "createdBy": null,
    "updatedBy": null
  },
  "properties": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "name": "Notes",
      "type": "title",
      "key": "string",
      "config": {
        "options": [
          null
        ],
        "numberFormat": "number",
        "decimals": 0,
        "currency": "string",
        "includeTime": false,
        "range": false,
        "relation": {
          "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
          "twoWay": false,
          "reversePropertyId": null,
          "limit": "one"
        },
        "rollup": {
          "relationPropertyId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
          "targetPropertyId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
          "function": "showOriginal"
        },
        "expression": "string",
        "prefix": "string",
        "extra": {}
      },
      "sortKey": "a0",
      "createdAt": "2026-11-12T09:30:00.000Z",
      "updatedAt": "2026-11-12T09:30:00.000Z",
      "deletedAt": null,
      "createdBy": null,
      "updatedBy": null
    }
  ],
  "views": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "name": "Notes",
      "type": "table",
      "config": {
        "filter": null,
        "sorts": [],
        "groupBy": null,
        "subGroupBy": null,
        "columns": [],
        "limit": null,
        "summaries": {},
        "layout": {},
        "extra": {}
      },
      "sortKey": "a0",
      "createdAt": "2026-11-12T09:30:00.000Z",
      "updatedAt": "2026-11-12T09:30:00.000Z",
      "deletedAt": null,
      "createdBy": null,
      "updatedBy": null
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.