{"access":{"authHeader":"x-nipmod-api-key","betaKeyIssue":{"body":{"label":"partner-name-or-agent-host"},"endpoint":"POST https://nipmod.com/api/keys/beta","note":"Self-serve beta keys are free and rate limited. Use partner keys for sustained integration traffic."},"coreApi":"key_required","publicSurfaces":["https://nipmod.com","https://nipmod.com/partners","https://nipmod.com/integrations","https://nipmod.com/agent-marketplace.json","https://nipmod.com/api-access-tiers.json","https://nipmod.com/benchmark","https://nipmod.com/stats"]},"contact":{"discord":"https://discord.gg/wYmatRDzk","email":"info@nipmod.com","github":"https://github.com/nipmod/nipmod","x":"https://x.com/Nipmod"},"endpoints":[{"method":"GET","path":"/api/search","purpose":"Find package, repo, model, dataset and MCP candidates across supported sources.","example":"https://nipmod.com/api/search?q=<query>&sources=npm,jsr,pypi,cratesio,go,maven,nuget,rubygems,packagist,dockerhub,homebrew,terraform,helm,conda,openvsx,cran,github,huggingface-model,huggingface-dataset,mcp&limit=5"},{"method":"GET","path":"/api/inspect","purpose":"Inspect one exact upstream object and return source context, trust signals and warnings.","example":"https://nipmod.com/api/inspect?source=npm&name=undici"},{"method":"GET","path":"/api/install-plan","purpose":"Return a read-only install plan and command boundary before local approval.","example":"https://nipmod.com/api/install-plan?source=npm&name=undici"},{"method":"GET","path":"/api/decision","purpose":"Return the complete reusable package decision object, including pre-execution checks, in one call.","example":"https://nipmod.com/api/decision?q=http%20client&sources=npm,pypi,github&limit=5"},{"method":"POST","path":"/api/decision","purpose":"Return the same reusable package decision from structured agent-host JSON.","example":"{\"query\":\"http client\",\"sources\":[\"npm\",\"pypi\",\"github\"],\"limit\":5}"},{"method":"POST","path":"/api/mcp","purpose":"Expose the same read-only package intelligence flow through a hosted MCP endpoint.","example":"https://nipmod.com/api/mcp"},{"method":"GET","path":"/agent-marketplace.json","purpose":"Return listing copy, endpoints, boundaries, proof links and commercial path for agent marketplaces and MCP directories.","example":"https://nipmod.com/agent-marketplace.json"},{"method":"GET","path":"/api-access-tiers.json","purpose":"Return operational key tiers, route policies and the current free beta to paid or partner access path.","example":"https://nipmod.com/api-access-tiers.json"},{"method":"GET","path":"/api/archive/prepare","purpose":"Preview a reusable package intelligence record after useful approved results.","example":"https://nipmod.com/api/archive/prepare?source=npm&name=undici"}],"formatVersion":1,"integrationSequence":["Agent identifies a package, repo, model, dataset, MCP server, SDK or CLI it wants to use.","Agent calls /api/search with a beta or partner key.","Agent chooses one candidate and calls /api/inspect for the exact record.","Agent calls /api/install-plan and shows trust signals, warnings and command boundary.","Or the agent calls /api/decision to receive recommendation, risks, evidence, alternatives, install plan, pre-execution checks and receipt in one response.","User or local host approves any install, clone, enablement, paid API setup or transaction handoff outside the hosted API.","If the result was useful, the host can prepare archive context for future reuse."],"limits":{"note":"Default limits are per key and route before any partner multiplier. Partner keys can be raised for real integrations.","routes":[{"limit":"120/min","path":"/api/search"},{"limit":"120/min","path":"/api/inspect"},{"limit":"90/min","path":"/api/install-plan"},{"limit":"75/min","path":"/api/decision"},{"limit":"240/min","path":"/api/mcp"},{"limit":"60/min","path":"/api/archive/prepare"},{"limit":"240/min","path":"/api/openapi"},{"limit":"240/min","path":"/api/sources/health"}]},"liveSourceSmoke":{"command":"pnpm source:canary","baseUrl":"https://nipmod.com","expected":"20/20 source families pass depth inspection","sources":["npm","jsr","pypi","cratesio","go","maven","nuget","rubygems","packagist","dockerhub","homebrew","terraform","helm","conda","openvsx","cran","github","huggingface-model","huggingface-dataset","mcp"],"purpose":"Use before partner demos to prove the hosted API can inspect representative public objects across every supported source family without executing, cloning, unpacking or writing."},"nonGoals":["hosted workspace writes","hosted package installation","repository cloning inside the hosted API","artifact unpacking or model execution","wallet custody or transaction signing","private package access","official partnership claims without approval"],"outputContract":{"decisionEventPreview":{"automaticSend":false,"endpoint":"included inside GET or POST https://nipmod.com/api/decision as partnerEventPreview","firstPilot":"one opted-in test agent or project only","receiver":"x402Books-compatible","schema":"https://nipmod.com/api/openapi#/components/schemas/PackageDecisionEventPreview","status":"preview_ready_not_auto_sent"},"inspectIncludes":["source record","sourceEvidence","trust fields","warnings","agentRecommendation"],"installPlanIncludes":["plan","safety","commandDetails","writes","approval boundary"],"searchIncludes":["records","selection","sources","archivePolicy"]},"decisionEventPilot":{"fields":["eventId","eventKind","generatedAt","package.id","package.source","package.name","package.version","package.installCommand","result.decision","result.riskLevel","result.trustScore","result.approvalRequired","proof.decisionSha256","proof.evidenceDigest"],"firstFlow":"Nipmod creates a preview-only event when an agent evaluates a package. A partner or host can send it only after explicit opt-in.","nonGoals":["automatic partner delivery","public agent profiles by default","wallet custody","transaction signing","raw prompt sharing"],"privacy":["no raw prompts","no secrets","no wallet phrases or private keys","no private repo content","no customer data"],"receiver":"x402Books-compatible","schema":"https://nipmod.com/api/openapi#/components/schemas/PackageDecisionEventPreview","status":"preview_ready_not_auto_sent"},"privacy":{"doesNotStore":["raw API keys","raw IP addresses","raw user agents","raw queries","workspace paths","prompts"],"usageStores":["route","method","status","access tier","key id","client hash","query hash","package hash","source","duration"],"workspaceDataRequired":false},"partnerOutlines":[{"name":"Clawnch","status":"draft_for_partner_review","fit":"Agent token launch and agent-tooling surfaces can call Nipmod before SDK, CLI, MCP or memory tooling enters a workflow.","firstFlow":"Preflight Clawnch SDK, CLI, MCP and memory candidates, then hand local install, wallet, token launch and trading actions back to Clawnch-controlled flows.","reviewAsk":"Confirm package names, docs links, surfaces to index and wording before any public claim.","publicLink":"https://nipmod.com/integrations/clawnch"},{"name":"Nookplot","status":"async_outline_ready","fit":"Agent coordination, identity, reputation and settlement can use Nipmod package decisions as one input to an agent activity or reputation trail.","firstFlow":"A Nookplot agent calls Nipmod before package, model, repo or MCP decisions, receives a decision receipt, then Nookplot decides what part belongs in its activity or reputation record.","reviewAsk":"Confirm which Nookplot action items should consume package decision receipts and which events should stay private.","publicLink":"https://nipmod.com/partners"},{"name":"x402Books","status":"pilot_proposal_needs_partner_green_light","fit":"Outcome and treasury visibility can use Nipmod decision receipts as the decision side of a later financial impact trail.","firstFlow":"One opted-in test agent receives a Nipmod package decision, keeps the full receipt private, and sends only the preview-safe decision event to x402Books-compatible infrastructure.","reviewAsk":"Confirm endpoint, authentication, event retention, agent id shape, default private profile policy and quote wording before any public claim.","publicLink":"https://nipmod.com/partners"},{"name":"Bankr","status":"async_outline_ready","fit":"Agent skill and onchain action workflows can use Nipmod before agents install or enable SDKs, skills, CLIs or MCP servers.","firstFlow":"A Bankr skill or agent host uses Nipmod preflight for package/tool discovery, then keeps any token, swap, payment or wallet action inside Bankr/Base approval boundaries.","reviewAsk":"Confirm whether this belongs as a skill, a docs integration, a demo workflow or only a preflight recommendation.","publicLink":"https://nipmod.com/partners"},{"name":"OpenHuman","status":"maintainer_review_needed","fit":"Agent skill directories can reference Nipmod as a pre-install package intelligence layer without importing mutable third-party skill files blindly.","firstFlow":"Use a pinned Nipmod skill or integration note that tells OpenHuman agents to call Nipmod before external package, repo, model or MCP server adoption.","reviewAsk":"Maintainer signoff, pinned reference strategy and supply-chain wording before any PR is treated as ready.","publicLink":"https://github.com/tinyhumansai/openhuman/pull/2432"}],"readinessChecklist":["Core calls use x-nipmod-api-key.","The integration treats package metadata and model cards as untrusted input.","The agent does not execute commands returned by /api/install-plan without local approval.","The host logs whether a package was accepted, rejected or escalated for review.","The partner does not claim official Nipmod or platform approval until both sides approve wording."],"status":"public_partner_pack","supportedSources":["npm","jsr","pypi","cratesio","go","maven","nuget","rubygems","packagist","dockerhub","homebrew","terraform","helm","conda","openvsx","cran","github","huggingface-model","huggingface-dataset","mcp"],"type":"dev.nipmod.partner-integration-pack.v1"}