Skip to main content

liyaengine

Official Python client for the Liya Engine public API.

Status: early access. This SDK currently covers Collections, Agents, and Workflows. More resources (Domains, Run, Guardrail Policies, Evals) ship incrementally — see Roadmap.

Install

pip install liyaengine

Quickstart

from liyaengine import LiyaEngine

client = LiyaEngine(api_key="liya_...")

collection = client.collections.create(
    slug="contracts",
    label="Contracts",
    domain_keys=["legal-ops"],
)

collections = client.collections.list()

Or as a context manager (closes the underlying HTTP connection pool automatically):

with LiyaEngine(api_key="liya_...") as client:
    collections = client.collections.list()

Get an API key from your Liya Engine dashboard under Settings → API Keys.

Agents

agent = client.agents.create(
    agent_key="support-triage",
    name="Support Triage",
    goal="Triage incoming support tickets and route them to the right team.",
)

# Agents are created in draft status — deploy to activate for execution.
client.agents.deploy(agent.agent_key)

result = client.agents.run(agent.agent_key, input={"message": "My order hasn't arrived yet."})

history = client.agents.list_runs(agent.agent_key)

Workflows

workflow = client.workflows.create(
    name="Lead Intake",
    steps=[{"step_type": "trigger", "config": {"trigger_subtype": "webhook"}}],
)

# Workflows are created in draft status — deploy to publish and make them
# callable. Deploying a webhook-triggered workflow for the first time mints
# its webhook secret; capture it immediately, it is never returned again.
deployed = client.workflows.deploy(workflow.workflow_key)
webhook_url, webhook_secret = deployed["webhook_url"], deployed["webhook_secret"]

# Roll the secret with a grace window so in-flight senders don't break.
client.workflows.rotate_webhook_secret(workflow.workflow_key, grace_period_seconds=300)

# Flip a deployed workflow on/off without touching its definition.
client.workflows.toggle(workflow.workflow_key)

result = client.workflows.run(workflow.workflow_key, input={"email": "ada@example.com"})

history = client.workflows.list_runs(workflow.workflow_key)

deploy() and rotate_webhook_secret() return the plaintext webhook secret exactly once. Store it immediately — subsequent reads (get, list) only ever expose trigger_config["has_secret"].

Error handling

Every failed request raises LiyaEngineAPIError, carrying the API's code, message, and HTTP status:

from liyaengine import LiyaEngineAPIError

try:
    client.collections.create(slug="contracts", label="Contracts", domain_keys=["legal-ops"])
except LiyaEngineAPIError as err:
    if err.code == "SLUG_CONFLICT":
        # handle the conflict
        pass
    raise

Network failures and timeouts raise LiyaEngineNetworkError instead. Requests are retried automatically on 429/5xx responses and transient network errors (2 retries by default).

Configuration

LiyaEngine(
    api_key="liya_...",
    base_url="https://api.liyaengine.ai",  # override for local/staging
    timeout_s=30.0,
    max_retries=2,
)

Roadmap

  • Collections
  • Agents (full CRUD, deploy, run, run/session history)
  • Workflows (full CRUD, toggle, deploy, webhook secret rotate, run, run history)
  • Domains (custom domain + intent CRUD)
  • Run / Run (streaming)
  • Guardrail Policies
  • Evaluations
  • Async client

Full docs: https://liyaengine.ai/docs/sdks/python

Development

python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
mypy src
pytest

License

MIT

Release files for liyaengine 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for liyaengine 0.3.0
File Size Uploaded
liyaengine-0.3.0.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for liyaengine 0.3.0
File Interpreter ABI Platform
liyaengine-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 24.9 kB

Release files / liyaengine-0.3.0.tar.gz

Download URL liyaengine-0.3.0.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
51ee2c7b39291ba0623b95f98fee2b9ad28b155e4b3ae742d41eec7e79dfd5c2
BLAKE2b-256 checksum
How to use checksums
11418ef2fe5028085ad4c63566c9eb41e89a858252ccfe9c9d1c590d49849c81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / liyaengine-0.3.0-py3-none-any.whl

Download URL liyaengine-0.3.0-py3-none-any.whl
Size 12.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
92d35f69e0fa3ce56b890374e84f80050eb5e95d30faa0c6961eef582afb9719
BLAKE2b-256 checksum
How to use checksums
f1e398dc8f0246a1e4e4393b1eb8d8b16bf8eca9566e8735dc183e1a6df8710c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release history Release notifications | RSS feed

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page