proof-server:proof-server-api

Document Midnight proof server HTTP endpoints and binary proving interfaces.

37|9|Updated Feb 25, 2026
One-click install
npx skills add https://github.com/devrelaicom/midnight-expert --skill proof-server-proof-server-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: proof-server:proof-server-api
Source: https://github.com/devrelaicom/midnight-expert/tree/main/plugins/proof-server/skills/proof-server-api
Command: npx skills add https://github.com/devrelaicom/midnight-expert --skill proof-server-proof-server-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a clear, developer-focused HTTP API reference for the Midnight proof server, removing ambiguity around endpoints, binary serialization, readiness semantics, and error handling so integrators can call proving endpoints reliably.

Core Features & Use Cases

  • Endpoint Reference: Detailed descriptions for /, /health, /ready, /version, /proof-versions, /prove, /prove-tx (deprecated), /check, /k, and /fetch-params including methods, request and response formats, and expected status codes.
  • Binary Serialization & Error Handling: Explains the midnight-serialize tagged binary format used by proving endpoints, plain text versus JSON responses, error codes (400, 429, 500), and CORS policy considerations.
  • Operational Guidance: Readiness metrics, worker utilization, job queue capacity semantics, and parameter pre-warming workflows for production and development deployments.
  • Use Case: Integrate the proof server with a DApp or wallet SDK to generate ZK proofs, validate preimages, pre-warm public parameters for specific k-values, and implement load-balancing health checks.

Quick Start

Show me how to call the proof server /prove endpoint with a serialized proof preimage to generate a ZK proof and interpret the binary response.

Frequently Asked Questions about proof-server:proof-server-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I call the Midnight proof server /prove endpoint to generate a ZK proof?▼

To generate a ZK proof with the Midnight proof server, send a serialized proof preimage to the /prove endpoint using the midnight-serialize tagged binary format, then interpret the returned binary response.

What is the midnight-serialize binary format used for proof server API requests?▼

The midnight-serialize binary format is a tagged serialization structure required by Midnight proving endpoints to encode proof preimages and parse responses reliably during DApp or wallet integration.

How does the proof server readiness check work for load balancing?▼

The proof server readiness check uses the /ready endpoint to report readiness metrics, worker utilization, and job queue capacity, enabling load balancers to route traffic only when the server can accept proving jobs.

Can I pre-warm public parameters on the proof server before generating proofs?▼

Yes, you can pre-warm public parameters for specific k-values using the /fetch-params and /k endpoints, reducing latency when the proof server processes subsequent ZK proof generation requests.

Why does the proof server return a 429 status code during ZK proof generation?▼

The proof server returns a 429 status code when the job queue capacity is full, indicating the server is temporarily rejecting proving requests until existing worker utilization decreases.

What endpoints are available on the Midnight proof server besides /prove?▼

The Midnight proof server exposes /, /health, /ready, /version, /proof-versions, /check, /k, and /fetch-params endpoints for health checks, versioning, parameter fetching, and preimage validation.