elan-sdk 0.1.0__tar.gz

elan_sdk-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+__pycache__/
+*.py[cod]
+.venv/
+.env
+.env.docker
+.uvcache/
+dist/
+build/
+*.egg-info/
+node_modules/
+.next/
+# TypeScript incremental build cache: rewritten by every portal build, so
+# tracking it dirties the tree on each one and now on every CI run.
+*.tsbuildinfo
+.terraform/
+.terraform.lock.hcl
+tfplan
+*.tfstate*
+.pytest_cache/
+.ruff_cache/
+catalog.json
+.ref/
+
+.local/
+# Per environment (ADR-0179): one shared file meant building for a second
+# environment overwrote the first's recorded digests.
+.platform-digests.*
+
+# Terraform plan files. Build artefacts, and a plan can carry values read
+# from state — including ones marked sensitive. `tfplan` alone did not match
+# `np.tfplan`, which is how one came to be committed.
+*.tfplan
+
+# Per-developer Claude Code settings. `.claude/settings.json` is the shared,
+# checked-in one; this is the personal override beside it, and it routinely
+# holds machine-specific permission grants — a `kubectl exec` allowance for
+# somebody's own cluster has no business in a repo that is also the starter
+# template for new projects.
+.claude/settings.local.json
+
+# GENERATED AT BUILD from the prerendered documentation, by
+# ui/console/scripts/gen-llms.mjs. A build artifact like `.next` and the SDK's
+# `dist`: committing it would mean a second copy of every documentation page
+# in the history, going stale between builds.
+ui/console/public/llms-full.txt

elan_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

elan_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.5
+Name: elan-sdk
+Version: 0.1.0
+Summary: The Elan API, as a developer's backend calls it
+Project-URL: Homepage, https://openelan.ai
+Project-URL: Documentation, https://openelan.ai/app/docs
+Author-email: Elan <support@openelan.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: adk,agent-platform,agents,ai,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: certifi>=2024.2.2
+Requires-Dist: elan-agentkit-contracts
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.9
+Requires-Dist: websockets>=13.0
+Description-Content-Type: text/markdown
+
+# elan-sdk
+
+Call the Elan platform's agents, approvals and billing from your own backend.
+
+Async-first, with a synchronous facade for scripts and notebooks. It talks to
+the same API the CLI and the console do.
+
+```bash
+uv add elan-sdk        # or: pip install elan-sdk
+```
+
+Requires Python 3.12 or newer.
+
+## The five-line version
+
+```python
+from elan_sdk import Elan
+
+elan = Elan.from_env()
+reply = elan.runtime.run("invoice-triage", "What do I owe on INV-9?")
+print(reply.text)
+```
+
+`from_env()` reads `ELAN_CLIENT_ID`, `ELAN_CLIENT_SECRET` and `ELAN_PROJECT`.
+`ELAN_API_URL` defaults to the production API, so you set it only to point
+somewhere else.
+
+That one call subscribes to the event stream, waits for the subscription to be
+acknowledged, publishes the invocation, filters the stream to this run, joins
+the reply's parts, stops at a terminal event and closes the socket. Every one of
+those steps is something a hand-rolled client has got wrong.
+
+`AsyncElan` is the same surface with `await`.
+
+## What it covers
+
+| Namespace | What it is for |
+|---|---|
+| `runtime` | start a run, watch its events, resume a paused one |
+| `runs` | read a finished run back |
+| `sessions` | conversations: create, list, read back and delete — from your agent's own database |
+| `actions` | the approval inbox, and deciding a tool confirmation |
+| `approvals` | approvals asked of somebody outside the conversation |
+| `tools` | long-running tool calls your own backend owes an answer to |
+| `autonomy` | what a tool may do without asking, per user and per tenant |
+| `wallets` / `credit` | your end users' balances — read and write, split apart |
+| `usage` / `analytics` | what your agents have consumed, and your own balance |
+| `artifacts` | files an agent can read, uploaded without passing through us |
+| `tickets` | a short-lived credential so a browser can watch a run |
+| `agents` | what is deployed, and what it declares |
+
+## Watching events yourself
+
+The rest of this page uses `AsyncElan`, since streaming is where `await` earns
+its keep. `Elan` has every one of these methods too, without the `await`.
+
+Subscribe **before** you invoke. That ordering is the whole reason this is a
+context manager — subscribing afterwards loses the entire reply on a warm agent.
+
+```python
+async with elan.runtime.watching("sess-ada-1") as stream:
+    await elan.runtime.invoke("hotel-concierge", "hi", session_id="sess-ada-1")
+    async for event in stream.events():
+        print(event.kind, event.text)
+```
+
+## Running for one of your end users
+
+`invoke` takes `end_user_id`; `run` deliberately does not. Naming a user
+addresses that run's events to **them**, so a backend that invoked and watched
+in one process would see nothing — the SDK raises `EndUserEventsElsewhere`
+rather than hanging.
+
+```python
+await elan.runtime.invoke(
+    "hotel-concierge", "refund my last night",
+    session_id="sess-ada-1", end_user_id="ada")
+```
+
+Their browser cannot hold your client secret, so mint a **ticket** — it opens
+the event stream and nothing else:
+
+```python
+ticket = await elan.tickets.mint(end_user_id="ada",
+                                 origin="https://app.acme.example")
+```
+
+## Seeding state and bounding a run
+
+`invoke`, `run` and `Conversation.say` take two of ADK's own `run_async`
+options. Both are sent only when set, so an ordinary message is unchanged.
+
+```python
+reply = await elan.runtime.run(
+    "hotel-concierge", "Is late checkout available?",
+    session_id="sess-ada-1",
+    state_delta={"room": "412"},
+    run_config={"max_llm_calls": 5,
+                "custom_metadata": {"request_id": "req-81c2"}})
+```
+
+- `state_delta` writes keys into **this conversation's** state on this turn.
+  `app:`, `user:`, `temp:` and `agentkit:` keys are refused with a `BadRequest`
+  naming the key — they would reach other users or other conversations, or
+  would not be kept. At most 64 KiB.
+- `run_config` accepts `max_llm_calls`, which can only **lower** the agent's
+  own limit, and `custom_metadata`, which ADK stamps on every event the run
+  emits. Anything else is refused by name.
+
+An agent deployed before these options existed must be **redeployed once**
+before it accepts an invocation carrying either.
+
+## Conversations
+
+A conversation lives in your agent's own database, and `elan.sessions` reads
+it there, through ADK's own session service — so the history is exactly what
+the agent saw.
+
+```python
+await elan.sessions.create("hotel-concierge", session_id="sess-ada-1",
+                           user="ada", state={"plan": "pro"},
+                           title="Late checkout for room 412")  # the agent never sees it
+
+for s in await elan.sessions.list("hotel-concierge", user="ada"):
+    print(s.id, s.title, s.state_keys)              # newest first
+
+events = await elan.sessions.events("hotel-concierge", "sess-ada-1",
+                                    user="ada", recent=200)
+for turn in await elan.sessions.turns("hotel-concierge", "sess-ada-1", user="ada"):
+    print(turn.role, turn.text)
+
+await elan.sessions.delete("hotel-concierge", "sess-ada-1", user="ada")
+```
+
+- **`events()` returns the same `AgentEvent`s the stream delivers**, so one
+  fold renders a live run and a reopened conversation, and `ends_the_run`
+  ends each turn in both. `turns()` is the messages alone; `get()` is the
+  state without the events; `run()` is a workflow's steps and pause.
+- **`user=` names one of your end users** by your own id and needs a tenant
+  admin. Without it, every method acts on the caller's own conversations.
+  Create and invoke for the same person — a conversation you create as
+  yourself is not the one an `end_user_id` invocation runs in.
+- **`recent` and `after` page a long conversation.** `after` is inclusive and
+  `seq` is numbered per response, so dedupe on `emitted_at`.
+- **A `Conflict` saying "redeploy it once" means exactly that**: the agent was
+  deployed before its history could be read.
+- Every method takes `project=`; without it, the client's own.
+
+`elan.runs` answers a different question — how one run ended and what it cost.
+
+## Paused runs
+
+A run that stops to ask a person something emits **no terminal event**. A client
+waiting for one waits out its whole timeout. Read the interrupt instead:
+
+```python
+from elan_sdk.models.events import ends_the_run
+
+async for event in stream.events():
+    if ends_the_run(event):
+        break
+```
+
+## Money
+
+Everything a wallet reports is **micro-USD** — divide by 1,000,000. Your
+tenant's own balance is in **tokens**, which is why the two use different field
+names (`balance_micros` against `balance_units`) rather than one whose unit a
+reader has to know.
+
+Reads and writes are deliberately separate objects: `elan.wallets` issues no
+non-GET at all, so a read-only credential can be handed it and a future write
+cannot quietly land on it. `elan.credit` is the write half.
+
+## Errors
+
+Every failure is an `ElanError` subclass carrying the status and the service's
+own message — `BadRequest`, `Unauthorized`, `Forbidden`, `NotFound`,
+`Conflict`, `TransportError`. Nothing raises a bare `httpx` exception.
+
+## Documentation
+
+Full guides, the API reference and the TypeScript half are at
+<https://openelan.ai/app/docs>.
+
+## Licence
+
+Apache-2.0. See `LICENSE`.

elan_sdk-0.1.0/README.md

@@ -0,0 +1,188 @@
+# elan-sdk
+
+Call the Elan platform's agents, approvals and billing from your own backend.
+
+Async-first, with a synchronous facade for scripts and notebooks. It talks to
+the same API the CLI and the console do.
+
+```bash
+uv add elan-sdk        # or: pip install elan-sdk
+```
+
+Requires Python 3.12 or newer.
+
+## The five-line version
+
+```python
+from elan_sdk import Elan
+
+elan = Elan.from_env()
+reply = elan.runtime.run("invoice-triage", "What do I owe on INV-9?")
+print(reply.text)
+```
+
+`from_env()` reads `ELAN_CLIENT_ID`, `ELAN_CLIENT_SECRET` and `ELAN_PROJECT`.
+`ELAN_API_URL` defaults to the production API, so you set it only to point
+somewhere else.
+
+That one call subscribes to the event stream, waits for the subscription to be
+acknowledged, publishes the invocation, filters the stream to this run, joins
+the reply's parts, stops at a terminal event and closes the socket. Every one of
+those steps is something a hand-rolled client has got wrong.
+
+`AsyncElan` is the same surface with `await`.
+
+## What it covers
+
+| Namespace | What it is for |
+|---|---|
+| `runtime` | start a run, watch its events, resume a paused one |
+| `runs` | read a finished run back |
+| `sessions` | conversations: create, list, read back and delete — from your agent's own database |
+| `actions` | the approval inbox, and deciding a tool confirmation |
+| `approvals` | approvals asked of somebody outside the conversation |
+| `tools` | long-running tool calls your own backend owes an answer to |
+| `autonomy` | what a tool may do without asking, per user and per tenant |
+| `wallets` / `credit` | your end users' balances — read and write, split apart |
+| `usage` / `analytics` | what your agents have consumed, and your own balance |
+| `artifacts` | files an agent can read, uploaded without passing through us |
+| `tickets` | a short-lived credential so a browser can watch a run |
+| `agents` | what is deployed, and what it declares |
+
+## Watching events yourself
+
+The rest of this page uses `AsyncElan`, since streaming is where `await` earns
+its keep. `Elan` has every one of these methods too, without the `await`.
+
+Subscribe **before** you invoke. That ordering is the whole reason this is a
+context manager — subscribing afterwards loses the entire reply on a warm agent.
+
+```python
+async with elan.runtime.watching("sess-ada-1") as stream:
+    await elan.runtime.invoke("hotel-concierge", "hi", session_id="sess-ada-1")
+    async for event in stream.events():
+        print(event.kind, event.text)
+```
+
+## Running for one of your end users
+
+`invoke` takes `end_user_id`; `run` deliberately does not. Naming a user
+addresses that run's events to **them**, so a backend that invoked and watched
+in one process would see nothing — the SDK raises `EndUserEventsElsewhere`
+rather than hanging.
+
+```python
+await elan.runtime.invoke(
+    "hotel-concierge", "refund my last night",
+    session_id="sess-ada-1", end_user_id="ada")
+```
+
+Their browser cannot hold your client secret, so mint a **ticket** — it opens
+the event stream and nothing else:
+
+```python
+ticket = await elan.tickets.mint(end_user_id="ada",
+                                 origin="https://app.acme.example")
+```
+
+## Seeding state and bounding a run
+
+`invoke`, `run` and `Conversation.say` take two of ADK's own `run_async`
+options. Both are sent only when set, so an ordinary message is unchanged.
+
+```python
+reply = await elan.runtime.run(
+    "hotel-concierge", "Is late checkout available?",
+    session_id="sess-ada-1",
+    state_delta={"room": "412"},
+    run_config={"max_llm_calls": 5,
+                "custom_metadata": {"request_id": "req-81c2"}})
+```
+
+- `state_delta` writes keys into **this conversation's** state on this turn.
+  `app:`, `user:`, `temp:` and `agentkit:` keys are refused with a `BadRequest`
+  naming the key — they would reach other users or other conversations, or
+  would not be kept. At most 64 KiB.
+- `run_config` accepts `max_llm_calls`, which can only **lower** the agent's
+  own limit, and `custom_metadata`, which ADK stamps on every event the run
+  emits. Anything else is refused by name.
+
+An agent deployed before these options existed must be **redeployed once**
+before it accepts an invocation carrying either.
+
+## Conversations
+
+A conversation lives in your agent's own database, and `elan.sessions` reads
+it there, through ADK's own session service — so the history is exactly what
+the agent saw.
+
+```python
+await elan.sessions.create("hotel-concierge", session_id="sess-ada-1",
+                           user="ada", state={"plan": "pro"},
+                           title="Late checkout for room 412")  # the agent never sees it
+
+for s in await elan.sessions.list("hotel-concierge", user="ada"):
+    print(s.id, s.title, s.state_keys)              # newest first
+
+events = await elan.sessions.events("hotel-concierge", "sess-ada-1",
+                                    user="ada", recent=200)
+for turn in await elan.sessions.turns("hotel-concierge", "sess-ada-1", user="ada"):
+    print(turn.role, turn.text)
+
+await elan.sessions.delete("hotel-concierge", "sess-ada-1", user="ada")
+```
+
+- **`events()` returns the same `AgentEvent`s the stream delivers**, so one
+  fold renders a live run and a reopened conversation, and `ends_the_run`
+  ends each turn in both. `turns()` is the messages alone; `get()` is the
+  state without the events; `run()` is a workflow's steps and pause.
+- **`user=` names one of your end users** by your own id and needs a tenant
+  admin. Without it, every method acts on the caller's own conversations.
+  Create and invoke for the same person — a conversation you create as
+  yourself is not the one an `end_user_id` invocation runs in.
+- **`recent` and `after` page a long conversation.** `after` is inclusive and
+  `seq` is numbered per response, so dedupe on `emitted_at`.
+- **A `Conflict` saying "redeploy it once" means exactly that**: the agent was
+  deployed before its history could be read.
+- Every method takes `project=`; without it, the client's own.
+
+`elan.runs` answers a different question — how one run ended and what it cost.
+
+## Paused runs
+
+A run that stops to ask a person something emits **no terminal event**. A client
+waiting for one waits out its whole timeout. Read the interrupt instead:
+
+```python
+from elan_sdk.models.events import ends_the_run
+
+async for event in stream.events():
+    if ends_the_run(event):
+        break
+```
+
+## Money
+
+Everything a wallet reports is **micro-USD** — divide by 1,000,000. Your
+tenant's own balance is in **tokens**, which is why the two use different field
+names (`balance_micros` against `balance_units`) rather than one whose unit a
+reader has to know.
+
+Reads and writes are deliberately separate objects: `elan.wallets` issues no
+non-GET at all, so a read-only credential can be handed it and a future write
+cannot quietly land on it. `elan.credit` is the write half.
+
+## Errors
+
+Every failure is an `ElanError` subclass carrying the status and the service's
+own message — `BadRequest`, `Unauthorized`, `Forbidden`, `NotFound`,
+`Conflict`, `TransportError`. Nothing raises a bare `httpx` exception.
+
+## Documentation
+
+Full guides, the API reference and the TypeScript half are at
+<https://openelan.ai/app/docs>.
+
+## Licence
+
+Apache-2.0. See `LICENSE`.