CommonsDB Developer PortalCommonsDB Developer PortalCommonsDB Developer Portal
  • Documentation
  • Declaration API
  • Metadata API
  • Search API
  • Status API
  • ISCC API
iscc
    Generate an ISCC for a filepostDecode an ISCCget
Schemas
powered by Zudoku
ISCC API

iscc

Endpoint:https://api.commonsdb.org

ISCC generation and decoding


Generate an ISCC for a file

POST
https://api.commonsdb.org
/v1/generate-iscc

Uploads a file and returns its ISCC-CODE (Meta, Content, Data and Instance units). Send the raw file bytes as the request body and the base64-encoded original filename in the X-Upload-Filename header. Supported media: images, text documents (plain text, PDF, DOCX, EPUB, ...), audio and video; unsupported types return 422. The file is only fingerprinted and is deleted from the service within minutes.

No API key is required. Requests are rate limited to 30 per minute per IP and the body is capped at 200 MB.

Generate an ISCC for a file › Headers

  • X-Upload-Filenamestring · required

    Original filename, base64 encoded (UTF-8). Used for media-type detection and the Meta-Code.

Generate an ISCC for a file › Request Body

string · binary

Generate an ISCC for a file › Responses

ISCC generated

  • isccstring · required

    Composite ISCC-CODE

  • namestring
  • descriptionstring
  • modestring · enum
    Enum values:
    text
    image
    audio
    video
    mixed
  • mediatypestring
  • filenamestring
  • filesizeinteger
  • widthinteger
  • heightinteger
  • durationnumber
  • thumbnailstring

    Data URL of an auto-generated preview (images, video, PDF)

  • datahashstring
  • metahashstring
  • unitsstring[]

    Full-length ISCC-UNITs the composite code was built from

POST /v1/generate-iscc

Decode an ISCC

GET
https://api.commonsdb.org
/v1/explain/{code}

Decodes an ISCC-CODE (or a single ISCC-UNIT) into its units with readable, hex, integer and bit representations.

Decode an ISCC › path Parameters

  • codestring · required

    The ISCC to decode, with or without the ISCC: prefix.

Decode an ISCC › Headers

  • Authorizationstring · required

    Bearer token for authentication (e.g., Bearer <your-api-key>)

Decode an ISCC › Responses

Decoded ISCC

  • isccstring
  • readablestring
  • multiformatstring
  • decomposedstring
  • unitsobject[]
GET /v1/explain/{code}