Limai Docs
API ReferenceProjects

Schema

Get the extraction schema for a project

GET/api/v1/projects/{projectId}/schema

Returns the full extraction schema for a project, including all tables and their columns.

Parameters

NameTypeInRequiredDescription
projectIdstringpathYesThe project ID

Request

const res = await fetch(
"https://app.limai.io/api/v1/projects/proj_abc123/schema",
{
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
  },
}
);
const schema = await res.json();

Response

Response200
{
  "projectId": "proj_abc123",
  "projectName": "Invoice Processing",
  "extractionSchemaId": "es_001",
  "instructions": "Extract invoice data",
  "tables": [
    {
      "id": "tbl_001",
      "name": "Invoices",
      "instructions": null,
      "isPrimary": true,
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-15T00:00:00.000Z",
      "columns": [
        {
          "id": "col_001",
          "name": "Invoice Number",
          "type": "TEXT",
          "description": null,
          "isList": false,
          "dateFormat": "EU",
          "tableId": "tbl_001",
          "sharedId": null,
          "excludedFromExtraction": false,
          "createdAt": "2025-01-01T00:00:00.000Z",
          "updatedAt": "2025-01-15T00:00:00.000Z"
        }
      ]
    }
  ]
}