SearchResponse
qstringThe ISCC query that was searched (with ISCC: prefix)
hashBitsstringBinary representation of the content hash bits used for search
invalidCountintegerNumber of results that were filtered out due to invalid data
versionstringAPI version
resultsobject[]Array of matching declarations sorted by similarity score (ascending)
SearchResult
s3MapItemIdstringInternal vector database ID
s3PathstringS3 path where the declaration is stored
scorenumberHamming distance score. Lower values indicate more similar content. Results with distance >= 10 are filtered out.
docBodyobjectCensored declaration data (excludes private metadata and signatures)
SearchResultDeclaration
metaInternalobjectInternal metadata for the declaration
declarationMetadataobject
PublicMetadata
$schemastring · uriSchema URL
@contextstring · uriJSON-LD context URL
isccstringISCC code
namestringTitle of the Work
descriptionstringDescription of the Work
mediatypestringMIME type of the content
thumbnailstringBase64-encoded thumbnail image
redirectstring · uriRedirect URL
sourceUrlstring · uriSource URL
timestampinteger · int64Unix timestamp in milliseconds
declarerIdstringDID of the declarer
entryUUIDstringEntry UUID from source system
versionintegerDeclaration version
CommonsDbRegistry
isccstringISCC code
locationstring · uriURL of the content at the supplier
rightsStatementstring · uriLicense/rights statement URL (Creative Commons or Public Domain)
timestampinteger · int64Unix timestamp in milliseconds
declarationIdstringReference to related declaration
credentialsobject[]Credentials with proofs