EgretAI
Log inGet Started Free

Quickstart

Get up and running with Egret in 5 minutes. This guide walks you through creating an account, getting an API key, and making your first RAG query.

1. Create an account

Sign up at getegret.com/signup. Every new account includes a free trial with credits to explore the platform.

2. Get your API key

Navigate to Settings → API Keys in the dashboard. Click "Create Key", give it a name, and copy the key. You'll use this for all API requests.

export EGRET_API_KEY="ek_live_..."

3. Explore available domains

List the knowledge domains available to your organization:

curl -H "Authorization: Api-Key $EGRET_API_KEY" \
  https://api.getegret.com/api/v1/domains/

4. Make your first query

Send a RAG query scoped to a domain:

curl -X POST https://api.getegret.com/api/v1/rag/query/ \
  -H "Authorization: Api-Key $EGRET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What are the data retention requirements under HIPAA?",
    "domain": "hipaa",
    "model_tier": "standard"
  }'

5. Read the response

The response includes the generated answer and an array of source citations:

{
  "answer": "Under HIPAA, covered entities must retain...",
  "citations": [
    {
      "document": "hipaa-privacy-rule.pdf",
      "section": "§ 164.530(j)",
      "text": "A covered entity must retain the documentation..."
    }
  ],
  "credits_used": 1,
  "model_tier": "standard"
}

Next steps