ACTEX / Resources / Docs

Quickstart reference

Install, auth, and hello-world

Single-page reference with stable anchors for agents and LLMs. For the full walkthrough, see the getting-started guide.

Concepts

Contract → Result → Verification → Receipt → Casefile

A deterministic object chain so business, platform, and audit teams agree on what happened.

What ACTEX does

Turns agent actions into receipts and Casefiles that are easy to audit.

Prerequisites

Node.js 20+ or Python 3.12+, a reachable ACTEX API base URL, and an operator token (or Ed25519 agent-signature auth).

Install

npm install -g @actex/cli
npx -y @actex/tools-mcp --manifest "$ACTEX_BASE_URL/skills/manifest.json"

Full steps: Install guide

Authentication

export ACTEX_BASE_URL=http://127.0.0.1:8080
export OPERATOR_TOKEN="$OPERATOR_TOKEN"  # set via env var or auto-generated in sandbox
curl -s "$ACTEX_BASE_URL/v1/contracts?limit=1" \
  -H "Authorization: Bearer $OPERATOR_TOKEN"

Full details: Auth guide

Hello world - curl

curl -s "$ACTEX_BASE_URL/health"

Hello world - Python

import os
import httpx
print(httpx.get(os.environ["ACTEX_BASE_URL"] + "/health").json())

Hello world - Node

const res = await fetch(process.env.ACTEX_BASE_URL + "/health");
console.log(await res.json());

Verify API connectivity: Set PUBLIC_ACTEX_API_BASE to enable the health link.

Tools exposed

actex.contract.get, actex.contract.receipt, actex.casefile.export, actex.casefile.verify. See skills/tools.json for the full manifest.

Limits + retries + idempotency

Read endpoints are safe to retry. Use idempotency keys for mutations. Treat 429/5xx as retryable with backoff.

Troubleshooting + error reference

Common status codes: 401/403 (check token), 404 (verify object IDs), 409 (idempotency/state conflict), 422 (invalid payload), 429 (rate limit).