Quickstart

npm install @provenancekit/sdk
# or
pnpm add @provenancekit/sdk

import { ProvenanceKit } from "@provenancekit/sdk";

const pk = new ProvenanceKit({
  apiKey: process.env.PK_API_KEY!,   // pk_live_... key from your project settings
  apiUrl: process.env.PK_API_URL ?? "https://api.provenancekit.com",
});

// Register the human author
const humanId = await pk.entity({
  role: "human",
  name: "Alice Chen",
});

// Register the AI agent
const aiId = await pk.entity({
  role: "ai",
  name: "GPT-4o",
  aiAgent: {
    model: { provider: "openai", model: "gpt-4o" },
    autonomyLevel: "supervised",
    delegatedBy: humanId,
  },
});

import { createHash } from "crypto";

const prompt = "Write a product description for noise-cancelling headphones.";
const output = "Experience pure silence with ProSound ANC headphones...";

// Content-addressed IDs — use IPFS CIDs in production
const promptCid = "sha256:" + createHash("sha256").update(prompt).digest("hex");
const outputCid = "sha256:" + createHash("sha256").update(output).digest("hex");

const actionId = await pk.file({
  type: "file.create",
  performedBy: aiId,
  inputs: [{ cid: promptCid }],
  cid: outputCid,
  sessionId: "sess_my_pipeline_run",
  extensions: {
    "ext:ai@1.0.0": {
      provider: "openai",
      model: "gpt-4o",
      promptHash: promptCid,
      tokensUsed: 320,
    },
  },
  attributions: [
    {
      entityId: humanId,
      role: "prompter",
      confidence: 1.0,
    },
  ],
});

console.log("Action recorded:", actionId);

// Get the full provenance bundle for a CID
const bundle = await pk.getBundle(outputCid);

console.log("Entities:", bundle.entities.map(e => e.name));
console.log("Actions:", bundle.actions.map(a => a.type));
console.log("Attributions:", bundle.attributions.map(a => a.role));

git clone https://github.com/Arttribute/provenancekit
cd provenancekit
pnpm install
cp apps/provenancekit-api/.env.example apps/provenancekit-api/.env
# Fill in DATABASE_URL, MANAGEMENT_API_KEY, etc.
pnpm --filter provenancekit-api dev