Skip to main content

HTTP / curl

The framework is a hosted HTTP API. Every SDK on this page is a thin wrapper. If your language isn't listed, hit the routes directly — the wire format is stable, documented, and identical across every SDK.

Get the CLI (recommended first install)

Every node serves the terminal CLI with a sha256-pinned installer — the fastest way onto the framework:

curl -fsSL https://zeqstate.com/install.sh | sh # any node works as the origin
zeq tutorial # guided: account → machine → first compute → verify

Full install notes + the complete command reference: /cli/.

First call — GET /api/zeq/pulse

curl -sS https://zeqapi.com/api/zeq/pulse | jq
{
"pulseHz": 1.287,
"zeqond": "2287568432",
"phase": 0.523,
"R_t": 1.000372,
"modulation": "α sin(2π·1.287·t)",
"timeToNextZeqond": 0.392
}

No authentication. Sub-40 mz response. Run it from a watch, a router, a satellite — the entangled state doesn't care.

Authed call — POST /api/zeq/compute

curl -sS https://zeqapi.com/api/zeq/compute \
-H "Authorization: Bearer $ZEQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"operators": ["KO42", "QM5", "GR40"],
"domain": "cross",
"inputs": { "t": 0 }
}'

Response carries:

FieldShape
value / unit / uncertainty / verificationnumeric + honest verification state
signedEd25519-signed claim — { claim: { registry_version, operators, inputs, value, unit, uncertainty, zeqond, … }, signature, public_key }, verifiable offline
equations[] / master_sumthe generative mathematics — one row per operator, plus the R(t) term breakdown
zeqProofHMAC-SHA256 receipt bound to your key prefix
zeqStateobject — domain, masterEquation, operator sequence, zeqond, phase
compliancezeq.compliance.v1 — 13-standard envelope
explorer_urldeep-link to the exact Zeqond tick in the State Explorer
tally_chargethe per-call wallet receipt

Full envelope: POST /api/zeq/compute.

Master-equation solve — POST /api/framework/solve

The compute endpoint above (/api/zeq/compute) returns a single textbook-formula value. To run the master equation itself and get a full trajectory + register dump, hit /api/framework/solve:

curl -sS https://zeqapi.com/api/framework/solve \
-H "Authorization: Bearer $ZEQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "feather drop",
"mass": 1e-4,
"location":"earth",
"medium": "air",
"koSettings": { "KO42": 1.0 }
}'

Response carries the trajectory plus a structured register dump:

{
"ckoId": "...", "errorPct": 0.0019, "energy": 1.3239,
"tEval": [...], "solution": [...], // φ(t), downsampled
"functionalEnergy": 20895.43, // E = P_φ · Z(M, R, δ, C, X)
"functionalEnergyTerms": { "P_phi": ..., "Z": ..., "M": ..., "R": ..., "delta": ..., "C": ..., "X": ... },
"registerDump": {
"phi_final": ..., "phi_range": ..., "frequency_Hz": ..., "period_s": ...,
"energy_K_mean": ..., "energy_U_mean": ..., "momentum_final": ...,
"angular_proxy_mean": ..., "zeroCrossings": ...
}
}

For N-body (Sun-Earth-Moon style):

curl -sS https://zeqapi.com/api/framework/multibody \
-H "Authorization: Bearer $ZEQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "sun-earth-moon",
"bodies": [
{ "mass": 1.989e30, "location": "sun", "object": "sun" },
{ "mass": 5.972e24, "location": "earth", "object": "earth" },
{ "mass": 7.342e22, "location": "moon", "object": "moon" }
],
"koSettings": { "KO42": 1.0, "NM21": 0.5, "GR35": 0.3 }
}'

Returns N per-body register dumps + N·(N−1)/2 pairwise force/separation summaries.

See the framework API reference for the full request schema and every optional flag (useOperatorModules, coreOnly, referenceMode, pairwiseCoupling, …).

Verify a result — no auth required

Every compute response carries an Ed25519-signed signed block. Hand it to any node's public attest endpoint and that node independently re-runs the physics and signs its own verdict:

curl -sS https://zeqapi.com/api/attest \
-H "Content-Type: application/json" \
-d '{
"claim": { …signed.claim from the compute response… },
"signature": "…signed.signature…",
"origin_public_key": "…signed.public_key…"
}'
# → { "protocol": "ZeqAttest", "ok": true, "attestation": { … } }

Or pipe the whole envelope to the CLI: … | zeq verify -.

Also public: POST /api/zeq/prove/verify for PROVE proofs and POST /zeq/compliance/verify for the compliance-envelope hash check. No key, no DB lookup, no contact with the framework owner.

Universal headers

HeaderMeaning
Authorization: Bearer <key>Account API key (zeq_ak_*) for /api/zeq/*
Authorization: Bearer <zsm-key>State-machine key (zsm_*) for /api/chain/<slug>/*
X-Zeq-OriginReturned on every response — names the api-core that served it
X-Zeq-Compliance-EnvelopeReturned on every compute — the envelope ID for SIEM scrapers

Where to go