open-agent-evidence-docs

Quickstart

This Quickstart helps you run the Agentic Evidence Logger (Developer Preview v0.1.0), install the Python SDK, and try the demo agent.

1) Start the backend

Option A: Run locally (Python)

Ensure your virtual environment is active and run the FastAPI app (already set up in your workspace).
The API key will be loaded from env AE_API_KEY or secrets/dev_api_key.

Option B: Run in Docker

Build the image:

docker build -t agentic-evidence-backend:alpha backend

Run the container with environment variables:

docker run --rm -p 8000:8000 \
  -e AE_DB_URL="sqlite:///data/app.db" \
  -e AE_STORAGE_BACKEND="local" \
  -e AE_API_KEY="<your-api-key>" \
  -e AE_PRIVATE_KEY_PATH="secrets/ed25519_private.key" \
  agentic-evidence-backend:alpha

Or run with mounted secrets file(s):

docker run --rm -p 8000:8000 \
  -v /Users/rajeshwar/compliance-workspace/agentic-evidence/backend/secrets/dev_api_key:/app/secrets/dev_api_key:ro \
  -v /Users/rajeshwar/compliance-workspace/agentic-evidence/backend/secrets/ed25519_private.key:/app/secrets/ed25519_private.key:ro \
  -e AE_DB_URL="sqlite:///data/app.db" \
  -e AE_STORAGE_BACKEND="local" \
  -e AE_API_KEY="$(cat /app/secrets/dev_api_key)" \
  -e AE_PRIVATE_KEY_PATH="/app/secrets/ed25519_private.key" \
  agentic-evidence-backend:alpha

Backend will be available at http://127.0.0.1:8000.

2) Install the Python SDK

pip install agentic-evidence-sdk

(For development in this repo, you can also install in editable mode: pip install -e sdk/python.)

3) Run the demo agent

The demo agent posts a minimal tool_invocation event and an attachment.

Edit environment variables in demo-agent/manifest.json if needed, then run:

python demo-agent/demo_agent.py

Expected output includes the recorded evidence ID and details such as status, signature, combined_hash, and artifacts_count.

4) Verify evidence via GET by ID

Use the evidence ID printed by the demo run, and query the backend:

GET /api/v1/evidence/{id}
Headers: X-API-Key:

Example using curl:

curl -s -H "X-API-Key: <your-api-key>" http://127.0.0.1:8000/api/v1/evidence/<evidence_id>

Environment variables summary

AE_DB_URL: Database URL (default: sqlite:///data/app.db)
AE_STORAGE_BACKEND: local s3
AE_API_KEY: API key for auth; if not set, backend reads secrets/dev_api_key or generates one
AE_PRIVATE_KEY_PATH: path to ed25519 signing key (optional for dev)
AE_ARTIFACT_DIR, AE_S3_BUCKET, AE_S3_REGION, AE_S3_PREFIX: storage configuration

Licensing

SDK and Demo Agent: Apache-2.0 (see sdk/python/LICENSE and demo-agent/LICENSE)
Docs: CC BY 4.0 (see docs/LICENSE-docs-CC-BY-4.0.txt)
Examples/snippets: CC0 (see examples/LICENSE-CC0.txt)
Backend: Proprietary notice under backend/