Quickstart

Release binding: v0.1.0-enterprise-ready · AMI ami-010806d4d3445660e · 2026-05-19

From launch to first query for an agreed Private Appliance or scoped pilot. HX-SDP is not currently offered through AWS or Google Cloud Marketplace. The release binding above identifies the dated reference configuration; use the release bundle supplied for your deployment.

1. Launch the appliance

1. Contact HolonomiX to agree the Private Appliance or scoped pilot, target infrastructure, and release bundle.
2. Verify the supplied bundle and import the agreed OVA or QCOW2, or load the OCI Runtime Kit. See Deploy: Private Appliance.
3. Continue with the runtime steps below after the agreed appliance is running. For a cloud target explicitly included in your pilot, use the supplied deployment instructions. The AWS and Google Cloud pages are archived technical references, not subscription instructions.

The dated AWS reference records a boot time of about 60 to 90 seconds on g5.2xlarge; confirm startup behavior on your agreed target.

2. Capture the bootstrap admin credential

It is generated at first boot and stored once:

sudo cat /opt/hx-sdp/secrets/bootstrap-admin.json

3. Verify health

curl -sk https://<host>:8443/health -H "Authorization: Bearer <ADMIN_KEY>"

Expect engine: ok, redis: ok, gpu: ok, manifest: verified.

4. Create a tenant

curl -sk -X POST https://<host>:8443/gate/onboard/create \
  -H "Authorization: Bearer <ADMIN_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"tenant_id": "team-a", "namespaces": ["team-a"]}'

The response contains the tenant key (hx_live_...), shown once.

5. Store a vector

curl -sk -X PUT https://<host>:8443/v1/put \
  -H "Authorization: Bearer <TENANT_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "doc-001",
    "namespace": "team-a",
    "data_b64": "<base64-encoded .npy>",
    "metadata": {"source": "quickstart"}
  }'

The response carries the Oracle verdict and the compression ratio for the entry.

6. Query

curl -sk -X POST https://<host>:8443/v1/query/vector \
  -H "Authorization: Bearer <TENANT_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"namespace": "team-a", "data_b64": "<base64-encoded .npy>", "k": 5}'

Query a stored key with POST /v1/query/topk. For a signed exact result, use POST /v1/query/exact and verify the receipt with POST /v1/attestation/verify.

7. Before production traffic

Replace the self-signed TLS certificate. See the Security Model.

Client libraries

The Python client is shipped with the appliance and the customer packet. TypeScript and Go clients are available on request until published.