API reference

Axiom platform API

Programmatic access to your AI company: read usage, your agent roster, company memory, and intel — or create tasks from your own systems. Included in the Pro and Scale plans.

Authentication

Create an API key in the dashboard under Settings → API Access. The full key is shown once at creation — we store only a hash. Send it on every request:

curl https://api.digitalixhub.com/v1/ping \
-H "Authorization: Bearer dxh_your_key_here"

The x-api-key header is accepted as an alternative. Keys can be revoked at any time from the same settings page.

Rate limit

120 requests per minute per key. Exceeding it returns 429 with a Retry-After header.

Plan requirement

API access is included in Pro and Scale. Tasks created via the API count toward your plan's monthly task cap.

Endpoints

https://api.digitalixhub.com/v1

GET/ping

Verify your key works. Returns the company the key belongs to.

Response

{ "ok": true, "companyId": "c0a8…" }

GET/usage

Current task usage against your plan's monthly cap.

Response

{
  "ok": true,
  "tier": "pro",
  "usage": { "tasksUsed": 412, "taskCap": 2000, "canCreateTask": true }
}

GET/agents

Your full agent roster with role, department, status, and autonomy level.

Response

{
  "ok": true,
  "agents": [
    {
      "id": "…", "name": "Remi Calloway", "shortName": "SDR",
      "role": "Sales development — qualifies inbound leads",
      "department": "sales", "status": "active", "autonomyLevel": "supervised"
    }
  ]
}

GET/memory

The 3-layer company memory: structured facts, event timeline, and narrative.

Response

{
  "ok": true,
  "memory": {
    "version": 14, "updatedAt": "…",
    "facts": [ { "category": "identity", "items": [ … ] } ],
    "events": [ … ],
    "narrative": "…"
  }
}

GET/intel?limit=25

Latest market-scout intel linked to your company (max 100 per request).

Response

{
  "ok": true,
  "intel": [
    { "id": "…", "category": "competitor", "title": "…", "summary": "…", "source": "…", "tags": [ … ] }
  ]
}

POST/tasks

Create a task. With agentShortName it enters the same queue as dashboard tasks — retries, metering, and the agent's autonomy level all apply (draft-mode output still lands in your approvals inbox). Without it, the task is created as pending for manual assignment.

Request body

{ "description": "Qualify the lead from acme.com", "agentShortName": "SDR" }

Response

{ "ok": true, "task": { "id": "…", "status": "queued" } }

Errors

Errors return a JSON body with a stable code:

{ "error": { "code": "UNAUTHORIZED", "message": "Invalid or revoked API key." } }

401 UNAUTHORIZED — missing, invalid, or revoked key.

403 TIER_LIMIT — your plan no longer includes API access.

429 — rate limit exceeded; respect Retry-After.

400 VALIDATION — malformed request body or parameters.

Questions or a missing endpoint you need? Tell us — the v1 surface grows with real usage.