Looking for a quick start? To run the complete flow end-to-end using example code, follow the Demo Tutorial.
The page below describes each step in detail and links to the relevant documentation.
Lattica's documentation assumes you have already compiled a TFHE program using Sunscreen.
If you haven’t compiled yet, go to Sunscreen’s docs and start from their compiler introduction.
Lattica helps deploy a TFHE program, control who can use it, and run it on workers so that your users can submit encrypted queries and receive encrypted results.
Note on terminology
In the Lattica platform documentation linked from this page, the term model refers to a deployable computational workload.
This corresponds with your compiled TFHE program for Sunscreen-based TFHE flows, even though it is not an AI or ML model.
All concepts (deployment, access tokens, workers, credits, query submission) apply in the same way.
Sign-up/sign-in to the Lattica Console (your team’s admin should do this).
In the Console, locate and download/copy your license.
Store it securely (Management Client and Query Client use depends on it).
Finance and account management are handled in the Console. Most technical operations can be done either in the Console or via the Management Client.
Lattica will run platform validation before execution, even after Sunscreen's compilation succeeded. You’ll see an error if validation fails, in which case you must fix the program and redeploy.
Access tokens are for users to use in the Query Client. Tokens are:
Model/program-specific. Each token grants permission to run queries on a specific program.
Time-limited (currently 30 days).
Not retrievable later (copy and store them securely when created).
Create tokens here: How‑To: Create User Access Token.
Treat tokens like passwords. Distribute them over a secure channel (never hard-code in public client apps).
Lattica uses a credit system:
Credits are consumed based on worker active runtime.
Workers stop when credits run out.
Start with:
Credit Management (workflow overview).
See Pricing for current compute rates and available packages.
Your program can process queries only when a worker is running. Start instructions: How‑To: Start Worker.
Because billing is runtime-based, you should stop workers when they’re not needed.
Stop instructions: How‑To: Stop Worker.
Rule of thumb: If there are no queries expected for a while → stop the worker → start it again before next usage.
Two things must be true before a user can run a query:
The user has an access token for this program.
At least one worker is running (and your account has enough credits).
Using an access token you provide.
Install instructions: How‑To: Install Query Client.
Each user generates:
A Secret Key (stays on the user's machine).
An Evaluation Key (uploaded to Lattica so encrypted computation can run).
This is a one-time setup per user/program in normal usage.
Follow: How‑To: Upload Evaluation Key.
For each query, the client performs the following steps:
Encrypts the input locally.
Executes the encrypted query on the Lattica backend.
Decrypts the encrypted result locally.
These three steps can be executed either separately or as a single command, depending on integration needs.
For a high-level view of how the client and backend interact, see: Query Submission (workflow overview)
Last updated
