HumanReviewed docs

Quickstart

From zero to a verifiable human-review attestation.

1. Get an API key

Sign in to the console, create an organization, and create an API key under API keys. It is shown once — store it in your secret manager as HR_API_KEY.

2. The flow, with curl

bash
# 1. Register the reviewer's identity (returns an identity UID)
curl -X POST https://api.humanreviewed.ai/v1/identities \
  -H "Authorization: Bearer $HR_API_KEY" -H "Content-Type: application/json" \
  -d '{ "subject": "user-123", "tier": 1, "displayName": "Alex Reviewer" }'

# 2. Create a review request for an artefact
curl -X POST https://api.humanreviewed.ai/v1/attestation-requests \
  -H "Authorization: Bearer $HR_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "artefactHash": "0x<sha256 of your canonical artefact JSON>",
    "agentId": "agent.acme.example/content",
    "agentRunId": "run-001",
    "reviewScope": "editorial",
    "signerIdentityUid": "0x<identity uid from step 1>"
  }'

# 3. The reviewer opens the signer link and signs. Then verify (free, no key):
curl https://api.humanreviewed.ai/v1/attestations/0x<uid>/verify

3. The same flow, with the SDK

typescript
import { HumanReviewedClient } from "@humanreviewed/sdk";

const hr = new HumanReviewedClient({
  baseUrl: "https://api.humanreviewed.ai",
  apiKey: process.env.HR_API_KEY!,
});

// Register the reviewer once; reused across every artefact they review.
const identity = await hr.registerIdentity({ subject: "user-123", tier: 1, displayName: "Alex Reviewer" });

// Request a review — the SDK hashes the artefact canonically for you.
const request = await hr.requestApproval({
  artefact,                                   // any JSON value
  agentId: "agent.acme.example/content",
  agentRunId: "run-001",
  reviewScope: "editorial",
  signerIdentityUid: identity.uid,
});

// A human signs in the signer app; then anyone can verify:
const verdict = await hr.verify(request.resolvedAttestationUid!);
Only a human issues
Creating a request never issues an attestation — the reviewer must sign it in the hosted signer app. There is no API to “submit on a human’s behalf” from an autonomous agent; that is the whole point.

Next

  • Put a badge on the reviewed output.
  • Turn on a compliance pack so issuance enforces your jurisdiction’s rules.
  • Receive results by webhook instead of polling.