LiyaEngine Docs
Guides

Quickstart

Make your first LiyaEngine API call in under 5 minutes.

Dashboard

This guide walks you through signing up, getting your API key, testing the sample domain, and then moving toward your own production domain.

1. Create an account

Sign up at liyaengine.ai/signup.

After verifying your email you'll land in the dashboard. From there, create your own domains, intents, agents, workflows, and knowledge base for production use. LiyaEngine also includes sample domains, such as hiring, so you can test the API shape and explore working examples before building your own.

For a production setup, continue with Building a custom domain after this quick API test.

2. Get your API key

In the dashboard, navigate to API Keys and click Generate Key. Copy the full key — it's only shown once.

Your key looks like: liya_prod_a1b2c3d4e5f6...

Store it in your environment:

export LIYA_API_KEY=liya_prod_a1b2c3d4e5f6...

3. Make your first test API call

Every intent call takes three fields — domain, intent, and input — posted to a single endpoint. This example uses the hiring sample domain for testing:

curl -X POST https://api.liyaengine.ai/v1/run \
  -H "X-API-Key: $LIYA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "hiring",
    "intent": "resume_analysis",
    "input": {
      "resume": {
        "raw_text": "Jane Smith\[email protected]\n\nExperience:\nSoftware Engineer at Acme Corp (2021-2024)\n- Built REST APIs in Node.js\n- Led migration to TypeScript",
        "file_type": "plain"
      },
      "user_id": "user_001"
    }
  }'

Response:

{
  "success": true,
  "data": {
    "output": {
      "overallScore": 72,
      "summary": "Strong technical background with clear progression...",
      "strengths": ["REST API design", "TypeScript migration experience"],
      "weaknesses": ["No cloud infrastructure experience mentioned"],
      "recommendations": ["Add metrics to impact statements", "Highlight team size"],
      "sections": { ... }
    },
    "session_id": "sess_01HZ...",
    "message_id": "msg_01HZ..."
  },
  "metadata": {
    "intent": "resume_analysis",
    "domain": "hiring",
    "model_used": "gpt-4o-mini",
    "tokens_used": 1100,
    "cost_usd": 0.00055,
    "latency_ms": 820,
    "cached": false
  }
}

4. Use the session ID for follow-up

Pass the data.session_id from step 3 to maintain context across turns:

curl -X POST https://api.liyaengine.ai/v1/run \
  -H "X-API-Key: $LIYA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "hiring",
    "intent": "resume_improvement",
    "input": {
      "resume": { "raw_text": "..." },
      "user_id": "user_001"
    },
    "options": {
      "session_id": "sess_01HZ..."
    }
  }'

The engine has full context from the previous resume_analysis call and will tailor improvements accordingly.

Next steps

Guides

Practical paths for making your first call, building domains, adding retrieval, keeping session context, and deploying LiyaEngine.

Example Domain Walkthrough

A sample testing domain — 17 real intents, request/response schemas, and knowledge sources — used throughout these docs as the running example.

On this page

1. Create an account2. Get your API key3. Make your first test API call4. Use the session ID for follow-upNext steps