Quick Start Guide

Source: docs/quick-start-guide.md

Quick Start Guide

This guide gets you from a demo key to your first deterministic interpretation.

1) Get an API key

Request a demo key from the tester portal. Demo keys are short-lived and rate-limited.

2) Send your first interpretation request

Hosted base URL: https://api.practice-wallet.com

The hosted gateway uses /api/* routes. If you run the runtime service directly, use the bare routes (/interpret, /replay, /diff).

Example:


curl -X POST "https://api.practice-wallet.com/api/interpret" \

  -H "Authorization: Bearer $API_KEY" \

  -H "Content-Type: application/json" \

  -d '{

    "artifact_text": "We aim to respond within 72 hours.",

    "artifact_type": "FREE_TEXT",

    "lens": { "lens_id": "literal_technical_reader", "lens_version": "v0.1" },

    "ruleset": { "ruleset_id": "facet_a_inference_mechanics", "ruleset_version": "v0.1" }

  }'

3) Read the response

The response includes:

  • analysis_run_id to replay or diff later
  • assumption_records (possibly empty)
  • boundary_map details inside each record
  • human_explanation when available (deterministic phrasing)

If no risky language is detected, assumption_records can be empty. That is a valid, expected outcome.

4) Replay a prior run

Replay is deterministic for a given artifact hash + lens + ruleset.


curl -X POST "https://api.practice-wallet.com/api/replay" \

  -H "Authorization: Bearer $API_KEY" \

  -H "Content-Type: application/json" \

  -d '{

    "artifact_hash": "<sha256>",

    "artifact_type": "FREE_TEXT",

    "lens": { "lens_id": "literal_technical_reader", "lens_version": "v0.1" },

    "ruleset": { "ruleset_id": "facet_a_inference_mechanics", "ruleset_version": "v0.1" }

  }'

5) Diff two runs

Use analysis run IDs to compute a deterministic diff.


curl -X POST "https://api.practice-wallet.com/api/diff" \

  -H "Authorization: Bearer $API_KEY" \

  -H "Content-Type: application/json" \

  -d '{

    "artifact_identifier": "terms-of-service",

    "analysis_run_id_a": "<run_a>",

    "analysis_run_id_b": "<run_b>"

  }'

Tips

  • Determinism applies to the boundary maps, not timestamps or run IDs.
  • Use the same lens and ruleset for replay/diff.