Records

Get record (flat)

Field-centric record with flat fields map keyed by path (FieldView per field). (flat)

get/records-flat/{id}

Request

  • Base URL: https://klaaro.ai/api/v1
  • URL: https://klaaro.ai/api/v1/records-flat/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

includestring

Comma-separated: events,comments

Response

OK

idstring uuid required
documentIdstring uuid required
datasetIdstring uuid required

UUID of the dataset this record belongs to

datasetSlugstring required

Slug of the dataset this record belongs to

rowIndexinteger required
sourcePageinteger nullable
createdAtstring date-time required
updatedAtstring date-time required
fieldsobject required

Keyed by field path (e.g. 'line_items[0].amount')

Example response

{
  "id": "2c0c2e50-5df6-4b1e-9a5e-c4b6e7a6c1b4",
  "documentId": "b6d2a7f6-0f44-44c8-8cc2-1d2e2bd7a5d5",
  "datasetId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "datasetSlug": "invoices-2026",
  "rowIndex": 0,
  "class": {
    "slug": "invoice",
    "name": "Invoice",
    "schemaHash": "9b7c7b2f6f9f0c52d32a1a6d0d1f3c747c1f9e8b132a4d2e2b9a7c6f0e1d2c3b",
    "classHash": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
  },
  "approval": {
    "status": "pending",
    "triggeredBy": [
      "unsure"
    ]
  },
  "createdAt": "2026-05-22T13:00:00Z",
  "updatedAt": "2026-05-22T13:00:00Z",
  "fields": {
    "line_items[0].amount": {
      "path": "line_items[0].amount",
      "fieldRoot": "line_items.amount",
      "value": 120,
      "schema": {
        "type": "currency",
        "required": true
      },
      "extraction": {
        "evidence": "120.00",
        "modelUnsure": true,
        "modelNote": "Handwriting ambiguous"
      },
      "review": {
        "isUnsure": true,
        "commentCount": 1,
        "eventCount": 0,
        "lastAt": "2026-05-22T13:00:00Z"
      },
      "validation": {
        "violations": [],
        "hasViolations": false
      }
    }
  },
  "crossField": {
    "validation": {
      "violations": [],
      "hasViolations": false
    }
  },
  "comments": {
    "count": 0,
    "preview": []
  }
}

Changes

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