API Reference · Database

Database schema

Tables, columns and indexes of a managed database (storage workloads only).

GET/v1/tenants/{name}/workloads/{id}/db/schema

Authorization

x-api-keystringrequired
Your per-workspace API key, e.g. llc_AbC123…. Also accepted as Authorization: Bearer <key>. Mint keys on your workspace's API keys page — each key belongs to one workspace.

Path parameters

namestringrequired
Workspace (tenant) name.
idstringrequired
Workload id within the workspace.

Response

200The live schema.

tablesarray
curl https://api.live-llm.com/v1/tenants/acme/workloads/web/db/schema \
  -H "x-api-key: $LIVELLM_KEY"
Try itGEThttps://api.live-llm.com/v1/tenants/{name}/workloads/{id}/db/schema
Fill required path params: name, id.
Example response200
{
  "tables": [
    {
      "schema": "public",
      "name": "orders",
      "rowEstimate": 18230,
      "columns": [
        {
          "name": "id",
          "type": "bigint",
          "nullable": false
        },
        {
          "name": "total_cents",
          "type": "integer",
          "nullable": false
        }
      ],
      "indexes": [
        {
          "name": "orders_pkey",
          "definition": "PRIMARY KEY (id)"
        }
      ]
    }
  ]
}