zkAPI
API Reference

API Reference

Every API surface touched in a zkAPI deployment

zkAPI has four API surfaces:

clientd

HTTP server on localhost:11434. Users call it as if it were the upstream API.

serverd

HTTP server on :3000. Verifies proofs, forwards to upstream, signs next state.

indexer

HTTP server on :3001. Mirrors the on-chain Merkle tree.

ZkApiVault

Ethereum settlement contract: deposits, mutual-close, escape-hatch.

Data flow

User app  ──►  clientd  ──►  serverd  ──►  upstream API
                 │              │
                 ▼              ▼
               indexer      nullifier store (SQLite)
                 │
                 ▼
          ZkApiVault (chain)

Full JSON shapes and error codes for all endpoints live in docs/openapi.yaml and docs/api-spec.md in the repository.

Cryptography

Primitives, post-quantum posture, domain separation

clientd

User-app-facing HTTP server on localhost:11434

On this page

Data flow