iscc-schema¶

JSON-LD Metadata and OpenAPI Service Descriptions for the International Standard Content Code.

What is iscc-schema?¶

iscc-schema provides the official schema definitions for the International Standard Content Code (ISO 24138:2024). YAML-based OpenAPI 3.1.0 definitions are the single source of truth for auto-generated JSON Schema, JSON-LD contexts, and Python models.

Install¶

pip install iscc-schema

Quick Start¶

from iscc_schema import IsccMeta

meta = IsccMeta(
    iscc="ISCC:KACYPXW445FTYNJ3CYSXHAFJMA2HUWULUNRFE3BLHRSCXYH2M5AEGQY",
    name="The Never Ending Story",
)

# Serialize as dict (set fields only)
meta.dict()
# {'iscc': 'ISCC:KACY...', 'name': 'The Never Ending Story'}

# Serialize as JSON (includes schema defaults)
meta.json()
# '{"@context":"http://purl.org/iscc/context","@type":"CreativeWork",...}'

Schema Categories¶

• ISCC Metadata. Core vocabulary for digital content identified by the ISCC. All fields are optional, covering content description, rights, technical properties, and cryptographic declarations.
• Seed Metadata. Industry-specific input for Meta-Code generation (ISBN, ISRC). Required fields ensure interoperable content fingerprinting across platforms.
• Service Metadata. Use-case-specific schemas for ISCC registries (TDM, GenAI). Machine-readable signals for text and data mining rights and generative AI disclosure.

Published Artifacts¶

Documentation¶

Documentation is hosted at schema.iscc.codes

Development¶

uv sync              # Install dependencies
uv run poe all       # Full build pipeline (codegen, tests, docs)

Status¶

Under development. Expect breaking changes until we reach a version 1.0 release.