eClips Tech
eClipsTech

Developer Manual

Quickstart

Install the SDK, point it at an API key, and run an enterprise AI agent in three lines. The eClips API is JSON over HTTPS, authenticated with a single bearer key — your organization and permission scopes ride on the key, so there is no org header to manage.

Install the SDK

The official client is @eclips/sdk — fully typed, with zero runtime dependencies. It works in Node.js 18+ and any modern runtime that ships fetch.

bash
npm install @eclips/sdk
Tip:The base URL defaults to https://api.eclips.tech. You never pass an organization id — it is resolved server-side from your API key.

Get an API key

Programmatic access uses keys that begin with eck_live_. Create one in the dashboard under Settings → API Keys, choosing the scopes the key needs. The key value is shown once — copy it and store it as a secret (for example in ECLIPS_API_KEY).

Run an agent in three lines

runAndWait() triggers an agent run and polls until it reaches a terminal state — completed, failed, or pending_triage.

typescript
import { EClipsClient } from "@eclips/sdk";

const client = new EClipsClient({ apiKey: process.env.ECLIPS_API_KEY! });
const result = await client.runAndWait("procurement_specialist", "Get 3 vendor quotes for 500 laptops");

The same call, expanded with logging:

typescript
import { EClipsClient } from "@eclips/sdk";

// The organization is derived from your API key — no org id is ever passed.
const client = new EClipsClient({ apiKey: process.env.ECLIPS_API_KEY! });

// runAndWait fires the run and polls until it reaches a terminal state.
const result = await client.runAndWait(
  "procurement_specialist",
  "Get 3 vendor quotes for 500 laptops — Dell, HP, Lenovo",
);

console.log(result.status);   // "completed"
console.log(result.result);   // { vendors: [...], recommended: "Dell" }

Prefer raw HTTP? The equivalent request returns a run_id immediately; orchestration is async.

bash
curl https://api.eclips.tech/v1/run \
  -H "Authorization: Bearer $ECLIPS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_type": "procurement_specialist", "task": "Get 3 vendor quotes for 500 laptops" }'

End to end

Example · From install to result

  1. •

    Create a key

    Dashboard → Settings → API Keys → create a key with the agents:run and agents:read scopes. Copy the eck_live_… value.
  2. •

    Install and configure

    npm install @eclips/sdk, then export your key: export ECLIPS_API_KEY=eck_live_….
  3. •

    Run

    Call runAndWait(agentType, task) — it resolves with the final { status, result, confidence_score }.
  4. •

    Go deeper

    Stream live status, register webhooks, or process hundreds of rows at once with batches.
← PreviousTips & FAQNext →Authentication & Scopes