First Steps

After you have access to an Eve instance and have created an organization, this guide walks you through the essential first steps to get productive.

Step 1: Log In and Get Your Token

First, authenticate to get a JWT token for API access:

bash

curl http://{host}:8000/api/v1/auth/login \
  -H "X-Org-Id: your_org_id" \
  -u your_username:your_password \
  -X POST

Response:

json

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Save this token for subsequent API calls:

bash

export TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Step 2: Create Your First User

If you're a SuperAdmin or Admin, you can create additional users:

bash

curl http://{host}:8000/api/v1/iam/humans \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "username": "developer@company.com",
    "password": "SecurePassword123!",
    "description": "Development team member",
    "perms": "RCA"
  }'

Permission Bits Options

Level	Description
Read	View and query resources
Write	Read permissions plus modify data
Admin	Write permissions plus manage configurations
SuperAdmin	Full control including other admin management

Step 3: Connect Your First Endpoint

Endpoints are connections to your databases and services. Here's how to connect a PostgreSQL database:

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "id": "my_postgres",
    "kind": "Postgres",
    "config": {
      "write_conn": {
        "url": "postgresql://user:password@db-host:5432/database"
      }
    }
  }'

Response:

json

{
  "status": "success",
  "data": {
    "id": "my_postgres",
    "uuid": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Step 4: Run Your First Query

Read Query

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres/read \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "query": "SELECT * FROM users LIMIT 10"
  }'

Response:

json

{
  "status": "success",
  "data": {
    "rows": [
      {"id": 1, "name": "John Doe", "email": "john@example.com"},
      {"id": 2, "name": "Jane Smith", "email": "jane@example.com"}
    ],
    "row_count": 2
  }
}

Write Query

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres/write \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "query": "INSERT INTO users (name, email) VALUES ($1, $2) RETURNING id",
    "params": ["Alice Johnson", "alice@example.com"]
  }'

Step 5: Grant Access to Your Team

Allow other users to access the endpoint:

bash

curl http://{host}:8000/api/v1/iam/control/endpoints/my_postgres/subjects/developer@company.com \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -X PUT \
  -d '{"perms":"RCA"}'

Step 6: Verify Your Setup

Check Your Organization

bash

curl http://{host}:8000/api/v1/organizations \
  -H "Authorization: Bearer $TOKEN"

List Your Endpoints

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Authorization: Bearer $TOKEN"

Check Your Permissions

bash

curl http://{host}:8000/api/v1/iam/access/endpoints/my_postgres \
  -H "Authorization: Bearer $TOKEN"

Common Endpoint Categories

Category	Example use case
Databases	Transactional data, documents, caches, analytics, and vector retrieval.
LLMs	Governed access to hosted or local model providers.
Applications	Collaboration, source control, observability, research, and CRM operations.
Servers, storage, and APIs	Internal services, object storage, serverless functions, and third-party APIs.
Platforms	Broad AWS, Azure, and Databricks service access.
Agents	Configured coding, assistant, and automation clients that use the Adam gateway.

Choose a category from the Endpoints guide, then use the specific endpoint or agent page for connection configuration.

Next Steps

Now that you have the basics set up:

Concepts - Understand Eden's core concepts
Endpoints - Learn about different endpoint types
RBAC - Set up access control for your team
Templates - Create reusable query templates

Quick Reference

Task	Endpoint	Method
Login	`/api/v1/auth/login`	POST
Create user	`/api/v1/iam/humans`	POST
Create endpoint	`/api/v1/endpoints`	POST
Read query	`/api/v1/endpoints/{id}/read`	POST
Write query	`/api/v1/endpoints/{id}/write`	POST
Grant access	`/api/v1/iam/control/endpoints/{endpoint}/subjects/{subject}`	PUT
Get organization info	`/api/v1/organizations`	GET

Last updated: July 10, 2026