Packages and libraries

How to use the tryVidimus API from your own code, and the packages published on npm.

Published on npm. The packages below are under the MIT licence and need Node.js 22 or later. The API itself is plain JSON over HTTPS and its schema is public, so any other language can call it directly.

npm packages

Open a package on npm for its version, its files and its licence.

@tryvidimus/cliThe command line: open a capture, follow proofs, verify one yourself and manage webhooks.Install or runnpm install -g @tryvidimus/cli
@tryvidimus/mcpThe MCP server for Claude and other MCP clients: open captures and read proofs from a conversation.Install or runnpx -y @tryvidimus/mcp
@tryvidimus/api-clientThe typed TypeScript client of the API.Install or runnpm install @tryvidimus/api-client
@tryvidimus/verifierVerify a proof without trusting our servers.Install or runnpm install @tryvidimus/verifier
@tryvidimus/proof-primitivesSHA-256, canonical JSON, Merkle tree and RFC 3161 timestamps: the building blocks the verifier uses.Install or runnpm install @tryvidimus/proof-primitives

All our packages on npm

Call it directly

No library is required. This call creates a capture session in the sandbox:

$ curl -X POST https://api.tryvidimus.com/v1/capture-sessions \
    -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: $(uuidgen)" \
    -d '{"external_reference":"booking_4471","party":"provider","stage":"pickup"}'

Keep your key in an environment variable such as TRYVIDIMUS_API_KEY, never in source code. A sandbox key starts with sk_test_.

Generate a typed client

The schema follows OpenAPI 3.1. Any generator that supports that version can produce a client for your language. For TypeScript types:

$ npx openapi-typescript https://api.tryvidimus.com/openapi.json -o tryvidimus.d.ts

The schema is also available in French by adding ?lang=fr; identifiers are the same in both languages.

Read the API reference