Documentation Index
Fetch the complete documentation index at: https://docs.fact0.io/llms.txt
Use this file to discover all available pages before exploring further.
Quickstart
Prerequisites
export LEDGERFLOW_API_KEY="alk_live_..."
pip install ledgerflow
Track 1 — Audit event (60 seconds)
import os
import ledgerflow
client = ledgerflow.Client(api_key=os.environ["LEDGERFLOW_API_KEY"])
client.audit.log(
actor={"id": "user_123", "type": "human", "email": "admin@acme.com"},
action="document.delete",
resource={"id": "doc_456", "type": "document", "name": "Q3 Report"},
outcome="success",
metadata={"ip": "203.0.113.5"},
)
client.close() # drain buffer; optional in long-running servers (atexit)
POST /v1/events/batch. By default the server accepts async ingest (202 + receipt); the SDK polls receipts automatically.
Open app.ledgerflow.io/dashboard/audit to see the event with sequence number and hash chain.
Read events back
events = client.audit.list_events(resource_id="doc_456", page_size=20)
for evt in events["events"]:
print(evt["action"], evt["outcome"])
Track 2 — Execution trace
import os
import ledgerflow
client = ledgerflow.Client(api_key=os.environ["LEDGERFLOW_API_KEY"])
with client.telemetry.execution(
agent_id="weather-bot",
agent_name="Weather Bot",
trigger="user_query",
) as ex:
with ex.span("tool.geocode", span_type="TOOL_CALL") as span:
span.log_event("query", {"city": "San Francisco"})
span.complete(output={"lat": 37.77, "lon": -122.42})
GET /api/v1/executions.
Async ingest and receipts
| Mode | How | Response |
|---|
| Async (default) | No header | 202 + receipt_id — poll GET /v1/receipts/{id} |
| Sync | sync=True on client or X-LedgerFlow-Sync: true | 201 / 200 with committed events |
Next steps
