Quickstart

This quickstart walks through the shortest end-to-end Literal integration path: register, authenticate, upload an encrypted document, wait for processing, and search it.

Literal’s API works with client-side cryptography. Your client performs authentication, key derivation, encryption, key wrapping, and blind index generation before calling the API.

Prerequisites

Before integrating, your client environment needs:

• OPAQUE support for registration and login.
• Client-side cryptography for document encryption, key derivation, key wrapping, and blind index generation.
• HTTP support for authenticated JSON requests and encrypted binary uploads.

1 — Register

Registration uses a two-step OPAQUE handshake.

Your client creates the registration request, derives local key material, encrypts private keys, and sends the finalized registration record to Literal.

Literal stores the registration record and encrypted client key material. It does not receive the user’s password or raw email.

See Authentication for the full registration flow and endpoint schemas.

2 — Log In

Login uses another two-step OPAQUE handshake.

Your client proves knowledge of the password without sending it to Literal. After the handshake completes, Literal issues a session. Your client receives the credentials needed for authenticated requests.

Use the access token for authenticated document, grant, and search requests.

See Authentication for session binding, token refresh, logout, and storage requirements.

3 — Upload An Encrypted Document

Document upload follows this flow:

1. Reserve a document slot.
2. Encrypt the document locally.
3. Wrap the document key for authorized access.
4. Generate document and search tokens.
5. Create the document record with encrypted metadata and wrapped key material.
6. Upload the encrypted bytes.
7. Poll until processing completes.

Literal stores encrypted content and processes the document inside the attested secure enclave during verification and indexing.

See Document Upload Guide for the full upload walkthrough.

4 — Search Your Documents

After processing completes, your client can search using blind index tokens generated locally.

Literal matches those tokens without learning the underlying search terms, then returns encrypted results for the client to decrypt.

See Encrypted Search for the search model and API Reference for endpoint schemas.

Last updated on