Datasets

Get class

get/datasets/{id}/classes/{class}

Request

  • Base URL: https://klaaro.ai/api/v1
  • URL: https://klaaro.ai/api/v1/datasets/{id}/classes/{class}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Dataset UUID (from GET /datasets).

classstring required

Class slug (unique per dataset), e.g. invoice.

Response

OK

slugstring required

URL-safe identifier, unique per dataset.

namestring required

Human-readable display name.

descriptionstring
colorstring
schemaHashstring required

SHA-256 of field definitions only. Changes on structural field changes.

classHashstring required

SHA-256 of full class definition (schema + display + behavior). Changes on any modification.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "slug": "invoice",
  "name": "Invoice",
  "description": "Invoice fields extracted from PDF invoices",
  "color": "#0ea5e9",
  "schemaHash": "9b7c7b2f6f9f0c52d32a1a6d0d1f3c747c1f9e8b132a4d2e2b9a7c6f0e1d2c3b",
  "classHash": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
  "fields": [
    {
      "name": "invoice_number",
      "type": "string",
      "description": "Invoice number",
      "required": true
    },
    {
      "name": "invoice_date",
      "type": "date",
      "description": "Invoice date",
      "required": true
    },
    {
      "name": "total_amount",
      "type": "currency",
      "description": "Total amount",
      "required": true
    },
    {
      "name": "line_items",
      "type": "array",
      "description": "Line items",
      "required": false,
      "arrayItemFields": [
        {
          "name": "description",
          "type": "string",
          "required": true
        },
        {
          "name": "quantity",
          "type": "number",
          "required": false
        },
        {
          "name": "amount",
          "type": "currency",
          "required": true
        }
      ]
    }
  ],
  "createdAt": "2026-05-22T13:00:00Z",
  "updatedAt": "2026-05-22T13:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.