Getting Started

Getting Started Guide

Go from zero to your first API call in under 5 minutes. This guide walks you through installing the SDK, authenticating, and making your first request.

Prerequisites

Node.js 18 or later
TypeScript 5.0 or later (recommended)
An EEv3 API key — request access

1. Install the SDK

Install the official SDK package from npm.

terminal

$ npm install @evileye/sdk

2. Get Your API Key

Navigate to the API Keyssection in your dashboard. Create a new key with the scopes you need. Store it securely — you won't be able to see it again.

Set the key as an environment variable:

.env.local

EE_TOKEN=sk_live_your_api_key_here

3. Initialize the Client

Create a client instance with your token and entity identifier.

lib/ee.ts

import { createClient } from '@evileye/sdk'

const ee = createClient({
  token: process.env.EE_TOKEN!,
  entity: 'my-company',
})

4. Make Your First Call

Use any face module to make a typed API call. Here we use ee.ai.generate to generate text with an LLM.

example.ts

const result = await ee.ai.generate({
  model: 'claude-sonnet-4-20250514',
  prompt: 'Summarise this document',
  context: 'EEv3 is a platform-as-a-service...',
})

console.log(result.data.text)

5. Check the Response

Every response follows the same envelope: a data field with the result and a meta field with request metadata.

response.json

{
  data: {
    text: "EEv3 is a comprehensive platform...",
    model: "claude-sonnet-4-20250514",
    tokens: { input: 42, output: 128 },
  },
  meta: {
    timing: 1240,
    requestId: "req_abc123",
    version: "4.2.0",
  },
}

Next Steps

API Reference— explore the /do endpoint and all capabilities
Authentication— learn about OAuth, scoped tokens, and JWT
Templates— jumpstart with production-ready starters