Developer docs · API 2.0.0

Run Eli's AI-search-to-pipeline loop from your product.

Read what Eli knows about the company, recommendation gap and buyer journey. Show the exact next action, ask for approval, run eligible work and preserve the verified outcome.

Open API referenceMCP setupAPI catalogEli skill

Authentication

Send Authorization: Bearer <credential>. REST v2 accepts either a user access token or an Eli API key. Create keys in the dashboard developer settings. A new key is displayed once; Eli stores only its hash.

Read workspace resources

Call GET /api/v2/{resource}. API-key reads require the read scope.

overview

Visibility summary for the selected workspace.

competitors

Literal competitor counts from saved AI answers.

traffic

AI-referred visits grouped by source.

revenue

CRM-verified, buyer-attributed and directional evidence kept separate.

actions

Pending own-site actions and the operation that can decide each one.

prompts

Tracked buyer questions and recent model evidence.

work-log

Recent engine cycles and work events.

onsite-changes

On-site proposals; add ?id=<uuid> for a full before/after preview.

content-drafts

Content drafts; add ?id=<uuid> for the full body and publication state.

growth

Evidence graph, selected growth intervention, execution route, blockers and learned outcomes.

company-intelligence

Source-aware company, offer, audience, proof, constraint, gap and conflict context for personalized work.

distribution-plan

The ranked, executable plan that connects measured demand to safe distribution and conversion actions.

reddit-intelligence

Saved Reddit source evidence, prioritized threads, human-final contribution work and remeasurement state.

curl https://hireeli.io/api/v2/actions \
  -H "authorization: Bearer eli_live_REPLACE_ONCE"

Fetch the full diff before deciding

curl "https://hireeli.io/api/v2/onsite-changes?id=CHANGE_UUID" \
  -H "authorization: Bearer eli_live_REPLACE_ONCE"

Track AI crawlers on your website

Forward HTTP request batches from your server, host or CDN. The key needswrite:own-site and the hostname must be covered by a fresh verified domain. Eli discards non-AI requests and stores only daily page, crawler, purpose, method and status-class totals. It does not store IP addresses, query strings, referrers or full user agents.

curl -X POST https://hireeli.io/api/v2/crawler-events \
  -H "authorization: Bearer eli_live_REPLACE_ONCE" \
  -H "x-eli-tenant: WORKSPACE_UUID" \
  -H "content-type: application/json" \
  -d '{"events":[{"timestamp":"2026-08-04T12:00:00Z","hostname":"example.com","request_path":"/pricing","request_method":"GET","status_code":200,"user_agent":"OAI-SearchBot/1.0"}]}'

Write with literal confirmation

Let Eli choose the measured page opportunity and prepare one review-only proposal:

curl -X POST https://hireeli.io/api/v2/onsite-proposals \
  -H "authorization: Bearer eli_live_REPLACE_ONCE"

The execution endpoints use the same decision core as the dashboard. The body valueconfirm: true must be the JSON boolean true. Strings such as "yes", the number 1, and free text are rejected. Always read the current resource first and ask the human to approve that exact preview.

API-key content publication requires both write:drafts and write:own-site. Dismissing a content draft requires only write:drafts; the other execution endpoints require write:own-site. For an already-published manual handoff, send provider: "manual_url" with the exact public publication_url.

POST /api/v2/crawler-events

send privacy-safe server or CDN events so Eli can measure known AI crawler access by page

POST /api/v2/onsite-proposals

choose and prepare the highest-priority existing-page proposal; nothing is applied

POST /api/v2/onsite-changes/{id}

approve, apply, revert or dismiss an on-site change

POST /api/v2/content-drafts/{id}

approve_publish or dismiss; supports a connected CMS or verified manual URL

POST /api/v2/corrections/{id}

approve or dismiss a correction

POST /api/v2/layer/publish

publish the reviewed AI-readable layer

curl -X POST https://hireeli.io/api/v2/onsite-changes/CHANGE_UUID \
  -H "authorization: Bearer eli_live_REPLACE_ONCE" \
  -H "content-type: application/json" \
  -d '{"action":"apply","confirm":true}'

Receipts

Every accepted machine write returns a receipt. Store the whole response. The resource ID and decision tie it to the audit log; status says what actually happened; URL and revert guidance identify the next safe step; caps show the durable daily write allowance. A requested write is never reported as applied unless the execution core can verify the outcome.

{
  "decision": "apply",
  "resourceId": "CHANGE_UUID",
  "status": "applied",
  "url": "https://example.com/page",
  "revertible": true,
  "revert_hint": "Call the confirmed revert operation for this change.",
  "caps": { "used": 1, "limit": 10, "window": "day" },
  "audit_id": "AUDIT_UUID"
}

Safety and limits

Agent skill

Install or copy the public Eli AEO skill into an assistant that supports agent skills. It contains the exact read → preview → confirm → approve workflow, receipt interpretation, a weekly review routine and REST v2 examples. The package is mirrored here for a future skills registry; the static files work now.

Public scan and published layers

The public scan requires no account and stays isolated in Eli's public tenant. Results are cached for seven days and bounded by existing public rate and cost caps.

curl -X POST https://hireeli.io/api/scan \
  -H "content-type: application/json" \
  -d '{"domain":"example.com"}'

Published customer layers remain public at /l/{slug}/llms.txt,/l/{slug}/capabilities.jsonand /l/{slug}/agents.md. These endpoints expose published material only, never private drafts.

REST v1

GET /api/v1/{resource} remains available for existing raw user-token integrations but is deprecated. New integrations should use v2 and a scoped API key. v1 never gains write methods.

Pricing