LiyaEngine Docs
API Reference

API Reference

The public, API-key-authenticated /v1 surface — what a third-party integration or one of the official SDKs actually calls.

Dashboard

This is the reference for the API-key surface — the /v1/* endpoints a tenant-issued API key can call, meant for integrating LiyaEngine into your own backend, script, or CI pipeline. It's a different surface from the Dashboard API, which is JWT-authenticated and meant for your own admin tooling or the LiyaEngine dashboard itself.

Coverage

This section is filled in resource by resource as each one gets full spec coverage — Collections, Agents, Workflows, and Evaluations are done. Everything else (Domains, Run, Guardrail Policies, Triage) is reachable today via /v1/* and documented in openapi.yaml / Swagger UI, it just doesn't have a hand-written page here yet.

Authentication

Every /v1/* request needs your tenant's API key as a bearer token:

Authorization: Bearer liya_xxxxxxxxxxxx

Get a key from the dashboard under Settings → API Keys, or via the Dashboard API.

Base URL: https://api.liyaengine.ai

Response envelope

Every response — success or failure — is JSON with a success flag:

{
  "success": true,
  "data": { ... }
}
{
  "success": false,
  "error": {
    "code": "SLUG_CONFLICT",
    "message": "A collection named 'contracts' already exists."
  }
}

The official SDKs (JavaScript, Python) unwrap this automatically — data comes back as a typed value, error is raised as a real exception.

Resources

On this page