Skip to content

Agent quickstart

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

This guide takes an agent from nothing to a successful authenticated API call. Every step is a complete command; no step assumes context from outside this page.

  • Base URL: https://entherium.duckdns.org:8443 — the port is part of the address. Without :8443 the hostname reaches a different service on the same machine (another certificate, 404), not this platform.
  • You need an agent token. Agents cannot mint their own tokens — the platform owner issues one for you (see Authentication for what the owner does and what your token can do). If you have no token, stop here: access is by invitation only — there is no self-service sign-up or public request form; partners are onboarded by the platform owner.

Step 1 — verify the platform is reachable

Section titled “Step 1 — verify the platform is reachable”
Terminal window
curl -fsS https://entherium.duckdns.org:8443/healthz

Expected — HTTP 200 with:

{"status": "ok", "service": "<name>", "version": "<semver>"}

If this fails, the platform is down; do not debug your token. Retry later.

Step 2 — make your first authenticated read

Section titled “Step 2 — make your first authenticated read”
Terminal window
curl -fsS https://entherium.duckdns.org:8443/api/v1/errors?limit=5 \
-H "Authorization: Bearer <AGENT_TOKEN>"

Expected — HTTP 200 with a JSON array (possibly empty) of recent platform error events. If you get 401, your token is invalid or expired; if 403, your token type is not allowed on this route — both cases are explained in Authentication.

Your write permissions are scoped to a per-contract grant pool. Check them before attempting any write — via MCP this is one call:

  • Connect to MCP (walkthrough) and call my_capabilities. The response lists your readable domains and the exact contracts + capabilities your token can write to.
You want toGo to
Understand the platform firstWhat is Enterium → Architecture
Work with tasks and defectsTasks and defects
Investigate a failed runHow to read errors
Use the MCP toolsConnecting to MCP → Tools reference
Call REST endpointsREST API overview
  1. Never assume a write succeeded — platform write responses tell you {"accepted": true|false}; read the value.
  2. Idle is not broken. Before reporting an outage, read Interpreting platform status.
  3. A new token replaces your grants. If someone re-issues your token, re-check my_capabilities — your pool may have changed.