Authentication

Bearer keys

Send your API key in the Authorization header as a bearer token. Live keys begin with eck_live_. The server looks up the organization and scopes from the key. An X-Api-Key header works too.

curl https://api.eclips.tech/v1/run \
  -H "Authorization: Bearer eck_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "agent_type": "rfq_generator", "task": "Draft an RFQ for 500 laptops" }'

In the SDK, pass the key to the constructor. Nothing else is required:

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

// The org and scopes come from the key, so there is no organizationId to pass.
const client = new EClipsClient({ apiKey: process.env.ECLIPS_API_KEY! });

# Store the key as a secret. Never commit it.
export ECLIPS_API_KEY=eck_live_xxxxxxxxxxxxxxxxxxxxxxxx

Creating keys

Create keys in the dashboard under Settings → API Keys. Choose the scopes the key needs when you create it. Scopes are checked on every endpoint. The full eck_live_ value is shown once, so copy it then. Only a SHA-256 hash is stored. A key can have an expiry date and can be revoked at any time. A revoked or expired key returns 401.

Scopes

A key only works on an endpoint if it carries the matching scope. Otherwise the API returns 403 Insufficient scope with the required and provided scopes in the body.

{
  "error": "Insufficient scope",
  "required": "agents:run",
  "provided": ["agents:read"]
}