Skip to main content

List Classes

List schema graph classes: the versioned ontology of document types Talonic discovers across your workspace, each with its canonical fields and version links.

The schema graph is a versioned ontology of document classes that Talonic discovers automatically across your workspace. Each class represents one recurring document type (an Invoice, a Purchase Order, a Lease Agreement) and captures its canonical fields as a JSON Schema. This endpoint lists every schema graph class in your organization, newest first, so you can see which document types the platform has learned from your data.

The API around the schema graph exposes five surfaces: versioned classes (this endpoint and its detail view), version history per class, diffs between versions with a review workflow, inter-class edges that measure how document types relate, and a D3-compatible visualization payload. Use the class list as the entry point: each item links to its own detail and version history.

Classes are created automatically as the platform processes documents and detects recurring field patterns. You never create a class by hand. Each class carries a status, a current_version_id pointing at its latest published version, and an optional document_type_id that ties it to the document classification pipeline.

Schema graph classes are discovered document types, not user-defined output schemas. Your extraction schemas live under /v1/schemas; both link to the same canonical field definitions in the field registry.
GET/v1/schema-graph/classes

curl

curl -s https://api.talonic.com/v1/schema-graph/classes \
  -H "Authorization: Bearer tlnc_your_api_key"

Response

Response fields

dataarrayArray of schema class objects.
data[].idstringSchema class UUID.
data[].schema_classstringCanonical class name (e.g. Invoice, Purchase Order).
data[].document_type_idstring | nullAssociated document type UUID.
data[].descriptionstring | nullOptional description of the class.
data[].current_version_idstring | nullUUID of the current active version.
data[].statusstringClass status (e.g. active, archived).
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.
data[].links.selfstringURL to this class.
data[].links.versionsstringURL to this class's version history.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "schema_class": "Invoice",
      "document_type_id": "doc-type-uuid",
      "description": "Standard invoice schema class",
      "current_version_id": "ver-uuid-3",
      "status": "active",
      "created_at": "2024-08-01T00:00:00.000Z",
      "updated_at": "2024-09-14T00:00:00.000Z",
      "links": {
        "self": "/v1/schema-graph/classes/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "versions": "/v1/schema-graph/classes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/versions"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Frequently asked questions

Are schema graph classes created automatically?+
Yes. Classes are generated automatically as the platform discovers recurring document types and their field patterns during extraction. You do not need to create them manually.
What does the current_version_id represent?+
It points to the latest published version of the class. Each time the platform publishes a new version of the class as the ontology evolves, `current_version_id` is updated to point to it.
How do schema graph classes relate to user schemas?+
Schema graph classes represent discovered document types in the ontology. User schemas are manually defined output schemas for extraction jobs. The two are linked through the field registry: both reference the same canonical field definitions.
What is a schema graph in document processing?+
A schema graph is a versioned ontology of document classes learned from your data. Each node is a document type with its canonical fields, and edges measure field overlap and semantic similarity between types.