Download OpenAPI specification:
MilliHash REST API for asset registration, verification, project lineage, portfolio management, and opt-in similarity search.
Hosts
https://free-api.millihash.io — public verification, stats, and sample proofhttps://millihash.p.rapidapi.com — authenticated registration, portfolio, projects,
similarity, plan, plus the same public verification routeshttps://app.millihash.com — operator admin audit (Auth0 JWT)Authenticated routes require X-RapidAPI-Key. Public verification routes require no auth.
Read-only audit search. Filters AND together; omitted parameters are wildcards.
Paginated; max 200 items per page. Requires Auth0 JWT with audit:read.
| eventType | string Exact event type filter |
| from | string <date-time> Inclusive lower bound on |
| to | string <date-time> Inclusive upper bound on |
| hash | string^[0-9a-f]{64}$ Proof digest hex associated with the event |
| certificateId | string <uuid> Certificate UUID associated with the event |
| userId | string Actor / registrant user id |
| cursor | string Opaque cursor from a prior |
{- "items": [
- {
- "eventType": "string",
- "occurredAt": "2019-08-24T14:15:22Z",
- "hash": "string",
- "certificateId": "93038071-4553-48f6-8780-c7262cd9be88",
- "userId": "string"
}
], - "nextPageCursor": "string",
- "resultCount": 0
}Hash the asset (or accept a client-supplied SHA-256), timestamp a version commitment with RFC 3161 TSA, persist the registration, and enqueue Bitcoin anchoring.
text) or client-supplied (hash); no body contentType.file + optional mediaType (sniff if omitted).| submissionMode required | string Value: "server-computed" Must be |
| registrantRole required | string Enum: "creator" "witness" Self-declared relationship to the asset. Not verified; immutable after create.
Omitted/blank/unknown → 400 |
| label | string <= 200 characters Immutable display label; omit/blank → permanently empty |
| labelPublic | boolean Default: false Show |
| internalLabel | string Private name; never on certificates or public APIs |
| mediaType | string Optional MIME. Sniffed when omitted or |
| file required | string <binary> Asset bytes (prefer JSON |
| similarityOptIn | boolean Default: false Opt into similarity indexing. Text-only; binary with true → 400 |
| discoverability | string Default: "hidden" Enum: "hidden" "label_visible" How this registration appears in similarity results when opted in |
{- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "hash": "string",
- "digests": [
- {
- "role": "proof",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "fingerprintSetVersion": "string",
- "contentHash": "string",
- "submissionMode": "server-computed",
- "registrantRole": "creator",
- "label": "string",
- "labelPublic": true,
- "internalLabel": "string",
- "discoverability": "hidden",
- "similarityIndexStatus": "pending",
- "tsaTimestamp": "2019-08-24T14:15:22Z",
- "tsaProvider": "string",
- "certificateUrl": "../dictionary",
- "keepOriginalsNotice": "string",
- "c2pa": {
- "c2paClaimGenerator": "string",
- "c2paSigningTime": "2019-08-24T14:15:22Z",
- "c2paSignerDisplayName": "string",
- "c2paSignerTrusted": true,
- "c2paDigitalSourceType": "string",
- "c2paHasIngredients": true,
- "trustNotice": "string"
}, - "priorRegistrationNotice": {
- "earliestPriorTsaTimestamp": "2019-08-24T14:15:22Z",
- "laterMatchCount": 0
}
}Re-upload the original asset for a registration you own. Proof digests, version commitment,
and original TSA stay unchanged. On success, MilliHash adds discovery fingerprints, advances
fingerprintSetVersion, and creates a separately timestamped / anchored FingerprintRefresh.
{ "text": "..." } for text registrations.file + optional mediaType.PROOF_HASH_MISMATCH.| registrationId required | string Registration to refresh (must be yours) |
| file required | string <binary> Original asset bytes |
| mediaType | string Optional MIME; sniffed when omitted (same rules as create) |
| similarityOptIn | boolean Default: false Opt an existing text registration into similarity. Binary with true → 400. Proof mismatch → 409 with no enqueue. |
| discoverability | string Default: "hidden" Enum: "hidden" "label_visible" Similarity visibility when opting in |
{- "fingerprintRefreshId": "string",
- "registrationId": "string",
- "linkKind": "fingerprint_refresh",
- "sequence": 1,
- "originalProofHash": "string",
- "digests": [
- {
- "role": "proof",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "fingerprintSetVersion": "string",
- "previousFingerprintSetVersion": "string",
- "tsaTimestamp": "2019-08-24T14:15:22Z",
- "tsaProvider": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "lineage": {
- "fingerprintSetVersion": "string",
- "refreshCount": 0,
- "latestFingerprintRefreshId": "string",
- "latestRefreshedAt": "2019-08-24T14:15:22Z",
- "outdated": true
}, - "keepOriginalsNotice": "string",
- "discoverability": "hidden",
- "similarityIndexStatus": "pending"
}Creates a project and version 1 registration from the same JSON/multipart shapes as
POST /registrations. Consumes one registration quota unit.
| submissionMode required | string Value: "server-computed" Must be |
| registrantRole required | string Enum: "creator" "witness" Self-declared relationship to the asset. Not verified; immutable after create.
Omitted/blank/unknown → 400 |
| label | string <= 200 characters Immutable display label; omit/blank → permanently empty |
| labelPublic | boolean Default: false Show |
| internalLabel | string Private name; never on certificates or public APIs |
| mediaType | string Optional MIME. Sniffed when omitted or |
| file required | string <binary> Asset bytes (prefer JSON |
| similarityOptIn | boolean Default: false Opt into similarity indexing. Text-only; binary with true → 400 |
| discoverability | string Default: "hidden" Enum: "hidden" "label_visible" How this registration appears in similarity results when opted in |
{- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "label": "string",
- "labelPublic": true,
- "internalLabel": "string",
- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "versionNumber": 1,
- "documentHash": "string",
- "digests": [
- {
- "role": "proof",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "contentHash": "string",
- "certificateUrl": "string",
- "chainVerifyUrl": "/projects/{projectId}/chain/verify"
}Adds version N+1 with a chained contentHash. Send X-Project-Head-Content-Hash
equal to the current head commitment or the request fails with a head conflict (409).
| projectId required | string <uuid> Project to append to (must be yours) |
| X-Project-Head-Content-Hash required | string^[0-9a-f]{64}$ Current head |
| submissionMode required | string Value: "server-computed" Must be |
| registrantRole required | string Enum: "creator" "witness" Self-declared relationship to the asset. Not verified; immutable after create.
Omitted/blank/unknown → 400 |
| label | string <= 200 characters Immutable display label; omit/blank → permanently empty |
| labelPublic | boolean Default: false Show |
| internalLabel | string Private name; never on certificates or public APIs |
| mediaType | string Optional MIME. Sniffed when omitted or |
| file required | string <binary> Asset bytes (prefer JSON |
| similarityOptIn | boolean Default: false Opt into similarity indexing. Text-only; binary with true → 400 |
| discoverability | string Default: "hidden" Enum: "hidden" "label_visible" How this registration appears in similarity results when opted in |
{- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "versionNumber": 2,
- "documentHash": "string",
- "digests": [
- {
- "role": "proof",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "contentHash": "string",
- "headContentHash": "string",
- "certificateUrl": "string"
}Cursor-paginated registry of registrations you own (page size 50).
Default sort: tsaTimestamp descending. Optional sort / direction;
tie-break is always registrationId ascending.
Rows include digests, labels, display name, and anchor state (no per-row anchor lookup).
| cursor | string Opaque cursor from a prior |
| sort | string Default: "tsaTimestamp" Enum: "tsaTimestamp" "label" "bitcoinBlockConfirmationTime" Primary sort field. |
| direction | string Enum: "asc" "desc" Sort direction. Defaults: |
{- "items": [
- {
- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "registrantKey": {
- "identityProvider": "rapidapi",
- "userId": "usr_alice"
}, - "label": "string",
- "labelPublic": true,
- "internalLabel": "string",
- "displayName": "string",
- "hashTruncated": "d41d8cd9…098f00bc",
- "digests": [
- {
- "role": "string",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "submissionMode": "server-computed",
- "tsaTimestamp": "2019-08-24T14:15:22Z",
- "tsaProvider": "string",
- "certificateUrl": "/certificates/6d0915e7-4f86-4f99-987e-57f8f83e8354",
- "anchorState": "Pending",
- "anchoredCertificateUrl": "/certificates/6d0915e7-4f86-4f99-987e-57f8f83e8354/anchored",
- "bitcoinBlockConfirmationTime": "2026-02-01T00:00:00.000Z",
- "fingerprintSetVersion": "string",
- "outdatedFingerprint": true,
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "discoverability": "hidden",
- "similarityIndexStatus": "pending",
- "c2pa": {
- "c2paClaimGenerator": "string",
- "c2paSigningTime": "string",
- "c2paSignerDisplayName": "string",
- "c2paSignerTrusted": true,
- "c2paDigitalSourceType": "string",
- "c2paHasIngredients": true,
- "trustNotice": "string"
}
}
], - "nextPageCursor": "string"
}Patch any subset of labelPublic, internalLabel, and discoverability.
Immutable label and proof digests are rejected.
labelPublic=true with an empty label → 400.
discoverability requires similarity opt-in → else 400 SIMILARITY_NOT_OPTED_IN.
| registrationId required | string <uuid> Registration to update (must be yours) |
| labelPublic | boolean Show |
| internalLabel | string or null Private name; size limited by plan |
| discoverability | string Enum: "hidden" "label_visible" Similarity result visibility; requires similarity opt-in |
{- "labelPublic": true,
- "internalLabel": "string",
- "discoverability": "hidden"
}{- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "label": "string",
- "labelPublic": true,
- "internalLabel": "string",
- "discoverability": "hidden"
}Renders the certificate PDF on demand for a registration you own. Same renderer version → byte-identical PDFs on repeat download.
| certificateId required | string <uuid> Certificate UUID |
{- "errors": [
- {
- "type": "string",
- "code": "string",
- "message": "string"
}
]
}Renders the Layer-1 + Bitcoin-anchored certificate PDF when the anchor is Confirmed.
Pending / Stamped / Failed → 409 ANCHOR_NOT_CONFIRMED.
| certificateId required | string <uuid> Certificate UUID |
{- "errors": [
- {
- "type": "string",
- "code": "string",
- "message": "string"
}
]
}Cursor-paginated list of projects you own (page size 50).
Ordered by createdAt descending, then projectId ascending.
| cursor | string Opaque cursor from a prior |
{- "items": [
- {
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "label": "string",
- "headVersionNumber": 0,
- "headRegistrationId": "48abb58e-ee67-44b8-a32f-adad62dc2391",
- "headContentHash": "string",
- "versionCount": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "nextPageCursor": "string"
}Returns a project you own, including an ordered version timeline.
| projectId required | string <uuid> Project id (must be yours) |
{- "project": {
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "label": "string",
- "headVersionNumber": 0,
- "headRegistrationId": "48abb58e-ee67-44b8-a32f-adad62dc2391",
- "headContentHash": "string",
- "versionCount": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}, - "versions": [
- {
- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "certificateId": "93038071-4553-48f6-8780-c7262cd9be88",
- "versionNumber": 0,
- "documentHash": "string",
- "contentHash": "string",
- "prevContentHash": "string",
- "tsaTimestamp": "2019-08-24T14:15:22Z"
}
]
}Checks sequential version numbers and contentHash links for a project.
Public; no ownership required.
| projectId required | string <uuid> Project UUID |
{- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "status": "valid",
- "label": "string",
- "versionCount": 0,
- "message": "string",
- "versions": [
- {
- "versionNumber": 0,
- "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
- "documentHash": "string",
- "contentHash": "string",
- "prevContentHash": "string",
- "certificateId": "93038071-4553-48f6-8780-c7262cd9be88",
- "tsaTimestamp": "2019-08-24T14:15:22Z"
}
]
}Hash the upload with the same normalization as registration and look up exact proof matches.
contentType=binary + file.contentType=text + text.| contentType required | string Value: "binary" Must be |
| file required | string <binary> Raw bytes to hash and look up |
{- "hash": "string",
- "digests": [
- {
- "role": "string",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "matchedAlgorithm": "string",
- "matchedTransform": "string",
- "matchedClass": "proof",
- "registrantRole": "string",
- "label": "string",
- "hitType": "standalone",
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "versionNumber": 0,
- "chainVerifyUrl": "string",
- "registrantSnapshot": {
- "name": "string",
- "email": "user@example.com"
}, - "tsaTimestamp": "string",
- "tsaProvider": "string",
- "submissionMode": "server-computed",
- "submissionModeNotice": "string",
- "semanticsNotice": "string",
- "additionalMatchCount": 0,
- "additionalMatches": [
- {
- "registrationId": "string",
- "tsaTimestamp": "string",
- "label": "string"
}
], - "c2pa": {
- "c2paClaimGenerator": "string",
- "c2paSigningTime": "2019-08-24T14:15:22Z",
- "c2paSignerDisplayName": "string",
- "c2paSignerTrusted": true,
- "c2paDigitalSourceType": "string",
- "c2paHasIngredients": true,
- "trustNotice": "string"
}
}Look up by certificate UUID or 64-char SHA-256 hex (case-insensitive).
Validates the TSA token and optional LTV chain. Does not return anchor state or PDF bytes.
shareableUrl is always keyed by certificate id.
| id required | string Certificate UUID or SHA-256 hex |
{- "certificateId": "93038071-4553-48f6-8780-c7262cd9be88",
- "hash": "string",
- "digests": [
- {
- "role": "string",
- "algorithm": "string",
- "transform": "string",
- "digestHex": "string"
}
], - "label": "string",
- "registrantRole": "string",
- "matchedAlgorithm": "string",
- "matchedTransform": "string",
- "matchedClass": "proof",
- "registrantSnapshot": {
- "name": "string",
- "email": "user@example.com"
}, - "tsaTimestamp": "string",
- "tsaProvider": "string",
- "submissionMode": "server-computed",
- "submissionModeNotice": "string",
- "tsaValidation": {
- "signatureValid": true,
- "chainValidatedTo": "string",
- "timeOfStampWithinSigningCertValidity": true,
- "revocationChecked": false
}, - "ltvChain": [
- {
- "provider": "string",
- "signedAt": "2019-08-24T14:15:22Z",
- "validationOutcome": "valid"
}
], - "c2pa": {
- "c2paClaimGenerator": "string",
- "c2paSigningTime": "2019-08-24T14:15:22Z",
- "c2paSignerDisplayName": "string",
- "c2paSignerTrusted": true,
- "c2paDigitalSourceType": "string",
- "c2paHasIngredients": true,
- "trustNotice": "string"
}, - "semanticsNotice": "string",
- "additionalMatchCount": 0,
- "additionalMatches": [
- {
- "registrationId": "string",
- "tsaTimestamp": "string",
- "label": "string"
}
]
}Look up by certificate UUID or SHA-256 hex. Returns the anchor job snapshot.
Certificate validity is independent of anchor state (certificateStillValid is always true on a hit).
| registrationId required | string Certificate UUID or SHA-256 hex |
{- "state": "Pending",
- "certificateStillValid": true,
- "otsBase64": "string",
- "bitcoinBlockConfirmationTime": "2019-08-24T14:15:22Z",
- "bitcoinBlockConfirmationTimeNote": "string",
- "estimatedConfirmationWindow": "string",
- "failureReason": "string",
- "attemptsExhausted": true,
- "totalAttempts": 4
}Aggregate service activity for public pages. Always includes timestampStandard and
anchoring. Optional fields appear only when thresholds are met (never zero-padded).
No hashes, labels, or registrant data. Cached up to 60 seconds.
{- "timestampStandard": "RFC 3161",
- "anchoring": "bitcoin-opentimestamps",
- "latestAnchorConfirmedAt": "2019-08-24T14:15:22Z",
- "usage": {
- "registrations": 0,
- "confirmedAnchors": 0,
- "lastRegistrationAt": "2019-08-24T14:15:22Z"
}
}Returns a MilliHash-registered text sample so you can try POST /verify
without your own content. Submit text unchanged with contentType=text.
{- "text": "string",
- "certificateId": "string",
- "registeredAt": "2019-08-24T14:15:22Z",
- "anchorState": "Pending"
}Embed the query and return ranked opted-in registrations as similarity candidates.
isOwn).hidden hits contribute only to privateMatchCount.text-normalized-v2) before size checks and embedding.limit (default 10, max 50) and cursor from a prior nextPageCursor.| query required | string UTF-8 search text. Blank → 400 QUERY_EMPTY. Size limited by plan maxSimilarityQuerySize after normalization. |
| mode | string Default: "idea" Enum: "idea" "wording"
|
| includeSamples | boolean Default: false When true, include MilliHash sample documents in the candidate pool. |
| limit | integer [ 1 .. 50 ] Default: 10 Max rows in this page. |
| minCosine | number [ 0 .. 1 ] Optional cosine floor for a hit. When omitted, idea uses ~0.82 and wording uses ~0.95. |
| cursor | string Opaque cursor from a previous |
{- "query": "An essay about tidal energy along rocky coasts.",
- "mode": "idea",
- "includeSamples": false,
- "limit": 10
}{- "results": [
- {
- "registrationId": "string",
- "recordedAt": "2019-08-24T14:15:22Z",
- "coarseScore": 1,
- "matchedPassageShare": 1,
- "meanBestCosine": 1,
- "candidateOnly": true,
- "label": "string",
- "isSample": true,
- "isOwn": true
}
], - "privateMatchCount": 0,
- "comparedAgainstCount": 0,
- "message": "Compared against 42 opted-in registrations on MilliHash.",
- "modelVersion": "string",
- "nextPageCursor": "string"
}Returns MilliHash-authored sample passages with paraphrase, weak, and unrelated query variants for trying search without registering your own text.
{- "samples": [
- {
- "id": "string",
- "label": "string",
- "text": "string",
- "paraphrase": "string",
- "weak": "string",
- "unrelated": "string"
}, - {
- "id": "string",
- "label": "string",
- "text": "string",
- "paraphrase": "string",
- "weak": "string",
- "unrelated": "string"
}, - {
- "id": "string",
- "label": "string",
- "text": "string",
- "paraphrase": "string",
- "weak": "string",
- "unrelated": "string"
}, - {
- "id": "string",
- "label": "string",
- "text": "string",
- "paraphrase": "string",
- "weak": "string",
- "unrelated": "string"
}, - {
- "id": "string",
- "label": "string",
- "text": "string",
- "paraphrase": "string",
- "weak": "string",
- "unrelated": "string"
}
]
}After you opt a registration into similarity, returns earlier candidates that overlap
it. While indexing status is pending, results are empty. Caller must own the registration.
| registrationId required | string Registration to check (must be yours and similarity-opted-in) |
{- "status": "pending",
- "results": [
- {
- "registrationId": "string",
- "recordedAt": "2019-08-24T14:15:22Z",
- "coarseScore": 1,
- "matchedPassageShare": 1,
- "meanBestCosine": 1,
- "candidateOnly": true,
- "label": "string",
- "isSample": true,
- "isOwn": true
}
], - "privateMatchCount": 0
}Returns the caller's subscription plan and byte ceilings for asset upload and similarity query text.
{- "plan": "BASIC",
- "maxAssetUploadSize": 10485760,
- "maxSimilarityQuerySize": 65536,
- "nextPlan": "PRO"
}