multichat-sdk 0.2.0__tar.gz

multichat_sdk-0.2.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+__pycache__/
+.pytest_cache/
+uv.lock
+dist/

multichat_sdk-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

multichat_sdk-0.2.0/NOTICE

@@ -0,0 +1,11 @@
+multichat-sdk (multiChat for Python: drop-in OpenAI and Anthropic clients)
+Copyright 2026 Digital Deep Ltd
+
+This product includes software developed by Digital Deep Ltd
+(https://www.multichat.io).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.
+
+Third-party software: this package bundles no third-party code. It uses the
+official openai (Apache-2.0) and anthropic (MIT) packages when they are
+installed, which pip installs separately under their own licences.

multichat_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.5
+Name: multichat-sdk
+Version: 0.2.0
+Summary: Drop-in OpenAI and Anthropic clients: call your provider directly with your own key, and get a durable conversation store, failover and shown savings from multiChat.
+Project-URL: Homepage, https://www.multichat.io
+Author: Digital Deep Ltd
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: anthropic,conversation,failover,llm,multichat,openai
+Requires-Python: >=3.9
+Provides-Extra: all
+Requires-Dist: anthropic>=0.49; extra == 'all'
+Requires-Dist: openai>=1.66; extra == 'all'
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.49; extra == 'anthropic'
+Provides-Extra: openai
+Requires-Dist: openai>=1.66; extra == 'openai'
+Description-Content-Type: text/markdown
+
+# multichat-sdk (Python)
+
+Change one import. Your code keeps calling OpenAI or Anthropic **directly, with your own key**,
+and multiChat gives it a durable conversation store, failover to a backup model, and the
+planner's savings shown before anything is changed.
+
+```python
+from multichat import OpenAI          # was: from openai import OpenAI
+
+client = OpenAI()                     # OPENAI_API_KEY as always; MULTICHAT_API_KEY for the store
+r = client.chat.completions.create(model="gpt-5.1", messages=[{"role": "user", "content": "Hello"}])
+```
+
+`multichat.OpenAI`, `AsyncOpenAI`, `Anthropic` and `AsyncAnthropic` are subclasses of the official
+clients: every argument, method and return type is theirs. Around each `chat.completions.create`
+(OpenAI) or `messages.create` / `messages.stream` (Anthropic) call the SDK:
+
+1. finds the call's conversation (one store session per conversation) by matching the message
+   list against what it recorded before, or by the `conversation=` handle you pass;
+2. sends only the new messages to the store as SYNC lines, in the background (the provider call
+   is never delayed or broken by the store; lines wait and go with the next turn if it is down);
+3. records the reply and its usage (`input`, `output`, `cache_read`, `cache_write`, `thinking`,
+   time, and who answered);
+4. asks the planner what it would change (`optimise="preview"`, the default) and shows it in
+   `client.multichat.last.changes` and on the `multichat` logger, without changing what you send;
+5. with Anthropic prompt caching and `keepalive=` on, schedules the cache keep-alive on the queue
+   and cancels it when your next turn starts.
+
+Nothing is routed through multiChat: the request goes from your process to the provider.
+
+## Install
+
+```sh
+pip install "multichat-sdk[openai]"      # or [anthropic], or [all]
+```
+
+Python 3.9+. The import name is `multichat`. (An unrelated PyPI package called `multichat`
+installs the same import name; do not install both.)
+
+## Sign in
+
+- `MULTICHAT_API_KEY`: an API key from the portal (for servers and CI), or
+- `multichat login` (or `python -m multichat login`): signs in through the portal in your browser
+  and saves a token to `~/.multichat/credentials.json` (mode 0600).
+
+`multichat_api_key=` on the client wins over both. multiChat never breaks your app: without a
+credential, or when the multiChat account is invalid or out of credit (the store answers 401, 402
+or 403), the client calls the provider directly and records nothing, with one warning on the
+`multichat` logger. `record=False` does the same on purpose (failover still works). Only the
+explicit multiChat calls (`advice`, `spend`, `files`, forks) raise `NotLoggedInError`. Service addresses: `MULTICHAT_STORE_URL`, `MULTICHAT_QUEUE_URL`, `MULTICHAT_PLANNER_URL`.
+
+## Conversations
+
+Calls are grouped by their message lists: a call whose messages start with what a conversation
+recorded (or, for a trimmed history, contain its last reply) continues it; anything else starts a
+new session. To be explicit:
+
+```python
+conv = client.multichat.conversation()            # or conversation("<session ID>") to continue one
+client.chat.completions.create(model=..., messages=msgs, conversation=conv)
+print(conv.session_id, conv.turn)
+```
+
+`client.multichat.last` is the last turn's `TurnInfo`: `session_id`, `turn`, `model`,
+`answered_by`, `usage`, `ms`, `sent` (the body that went to the provider), `changes`, `x`, `y`.
+`client.multichat.flush()` waits until the store has everything; `close()` and `with` do it too.
+
+## Optimise
+
+- `optimise="preview"` (default): the planner's proposal (model on the flip ladder, compaction,
+  cache markers, with the X vs Y cost) is fetched after each turn and shown; nothing changes.
+- `optimise=True`: the turn is stored first and the assembled request from the store is sent
+  instead of yours (`TurnInfo.sent` and `changes` show exactly what and why). If the store is
+  unreachable, your own request goes.
+- `optimise=False`: no planner call.
+
+Set it on the client or per call (`create(..., optimise=True)`).
+
+## Advice and guardrails
+
+```python
+from multichat import OpenAI, Guardrails, GuardrailError
+client = OpenAI(guardrails=Guardrails(max_session_usd=2.0, max_turn_usd=0.25, max_context_tokens="session"))
+advice = client.multichat.advice()        # {spend, findings: [{title, cost_usd, saving_usd, fixes}]}
+for fix in advice["findings"][0]["fixes"]:
+    client.multichat.apply_fix(fix)       # an SDK option, or a fork with better settings
+```
+
+A limit passed raises `GuardrailError` before the provider is called (`on_limit="warn"` sends
+anyway). `stable_tools=True` sorts tools by name so an order change does not break the prompt
+cache. Details: `docs/v2/advice.md`.
+
+## Failover
+
+```python
+from multichat import OpenAI, Anthropic, Backup
+
+client = OpenAI(failover=Backup(client=Anthropic(), model="claude-sonnet-4-5", after_ms=3000))
+r = client.chat.completions.create(model="gpt-5.1", messages=msgs)   # always a ChatCompletion
+```
+
+- The primary starts at once. If it has sent no token after `after_ms`, the backup starts too;
+  the first to answer is used. A rate limit, overload (429, 529, 503...), timeout or connection
+  failure starts the backup at once; other errors (a bad request, a bad key) are raised as they are.
+- The request is converted locally (OpenAI and Anthropic messages, images, documents, tool calls
+  and tool results; `convert="service"` uses the planner's `/v2/convert`), and the answer comes back
+  in the primary's shape: a `ChatCompletion` for OpenAI, a `Message` for Anthropic, or their
+  stream events when you streamed (the backup's answer then arrives whole as a short stream).
+- Per call: `create(..., failover=Backup(...))`, or `failover=None` to turn it off.
+- `Backup(params={"max_tokens": 1024})` adds fields for the backup only. Sampling settings
+  (`temperature`, `top_p`) are not carried to Anthropic, whose current models do not take them.
+- Queue mode: `Backup(..., mode="queue", key_mode="held")` asks the multiChat queue to send the
+  backup at `after_ms` with your backup key (held encrypted, deleted once fired), or
+  `key_mode="webhook", webhook="https://..."` to have your endpoint send it. The primary's first
+  token cancels it. If the queue cannot be reached the in-process timer is used.
+
+## Keep-alive (Anthropic)
+
+```python
+client = Anthropic(keepalive=KeepAlive())           # or keepalive=True
+```
+
+When a request carries `cache_control`, the queue sends the exact request again (`max_tokens=1`)
+at send time + TTL - 30 s (TTL 5 minutes, or 1 hour), and again a TTL later while the session's
+enhanced cache extensions last (the queue keeps the count, so a chain never goes past what the
+session allows), so the cache is warm for your next turn; that turn cancels the chain. A client
+pointed at another deployment (`base_url`) has its keep-alives and queue-mode backups sent there. The queue needs your key: it is held
+encrypted until the task fires (`key_mode="held"`), or use `key_mode="webhook"`. Off by default.
+
+## Keeping the official client
+
+```python
+import multichat, openai
+
+client = openai.OpenAI()
+messages = multichat.messages(client=client)          # a list the official client takes as is
+messages.add_prompt("Describe this", images=["https://example.com/cat.jpg"])
+r = client.chat.completions.create(model="gpt-5.1", messages=messages)
+messages.add_response(r)                              # appended and recorded
+```
+
+- `Session(client, model=..., optimise=..., session_id=...)`: one conversation in the store.
+- `Messages(session)`: the session's messages in the client's format (Anthropic's `system` kept
+  in `messages.system`); `add_system`, `add_prompt(text, images=, documents=)`, `add_response(r)`,
+  `add_tool_result(call_id, output)`, `render("anthropic")` for the other provider.
+- `Model(name, session)`: the name to send; with `optimise=True` the planner's model for the turn.
+- `turn(session, failover=...)`:
+
+```python
+async with multichat.turn(session, failover=multichat.Backup(client=claude, model="claude-sonnet-4-5")) as t:
+    t.messages.add_prompt("And in French?")
+    r = await t.call(client.chat.completions.create)      # calls with t.model and t.messages, records the reply
+```
+
+`t.add_response(r)` records a reply you got yourself. A turn that closes without a recorded
+reply warns (`RuntimeWarning`).
+
+## Workspace (run_code)
+
+Give the model a private workspace per conversation: Python or bash, a `/work` folder kept for 24
+hours, the account's files in (`files_in`) and every file the run makes saved to the account's
+files. Answer its `run_code` calls with `Workspace.handle`:
+
+```python
+from multichat import OpenAI, Workspace, workspace
+
+client = OpenAI()
+ws = Workspace()                                 # MULTICHAT_WORKSPACE_URL overrides the address
+reply = client.chat.completions.create(model="gpt-5.1", messages=msgs, tools=[workspace.openai_tool()])
+for call in reply.choices[0].message.tool_calls or []:
+    if call.function.name == workspace.TOOL_NAME:
+        result = ws.handle(session_id, call.function.arguments)   # the tool result text
+```
+
+`workspace.anthropic_tool()` for Anthropic. The call and its result are recorded with the next
+turn, like any tool call. Details: `docs/v2/workspace.md`.
+
+## Files
+
+Your files live in your account's regional bucket; conversations hold a reference (`mcfile:<id>`),
+and the store gives providers a short-lived signed link, or the bytes inline for a provider that
+does not fetch links.
+
+```python
+f = client.multichat.files.upload("chart.png", session=client.multichat.last.session_id)
+url = client.multichat.files.link(f["id"], ttl=600)["url"]      # at most 7 days
+client.multichat.files.save_to_project(f["id"], "launch")        # kept when the chat is deleted
+```
+
+Inline images, audio and documents in your requests still go to the provider exactly as written;
+the store records the uploaded file's reference instead of the bytes (`record_files=False` keeps the
+bytes). A file tied to a conversation is deleted with it unless saved to a project.
+
+## Conversion
+
+`multichat.convert_request(req, "openai.chat", "anthropic.messages", model)` and
+`multichat.convert_response(resp, from_format, to_format)` are the converters failover uses.
+
+## Tests
+
+```sh
+uv run pytest
+```
+
+Unit tests only: the services are an in-memory transport and the providers are fake servers
+behind the official clients' own mock transport. Nothing reaches a network or a provider.
+
+## Licence
+
+Apache License 2.0: see `LICENSE`, with the attribution notices in `NOTICE`.
+Copyright 2026 Digital Deep Ltd.

multichat_sdk-0.2.0/README.md

@@ -0,0 +1,211 @@
+# multichat-sdk (Python)
+
+Change one import. Your code keeps calling OpenAI or Anthropic **directly, with your own key**,
+and multiChat gives it a durable conversation store, failover to a backup model, and the
+planner's savings shown before anything is changed.
+
+```python
+from multichat import OpenAI          # was: from openai import OpenAI
+
+client = OpenAI()                     # OPENAI_API_KEY as always; MULTICHAT_API_KEY for the store
+r = client.chat.completions.create(model="gpt-5.1", messages=[{"role": "user", "content": "Hello"}])
+```
+
+`multichat.OpenAI`, `AsyncOpenAI`, `Anthropic` and `AsyncAnthropic` are subclasses of the official
+clients: every argument, method and return type is theirs. Around each `chat.completions.create`
+(OpenAI) or `messages.create` / `messages.stream` (Anthropic) call the SDK:
+
+1. finds the call's conversation (one store session per conversation) by matching the message
+   list against what it recorded before, or by the `conversation=` handle you pass;
+2. sends only the new messages to the store as SYNC lines, in the background (the provider call
+   is never delayed or broken by the store; lines wait and go with the next turn if it is down);
+3. records the reply and its usage (`input`, `output`, `cache_read`, `cache_write`, `thinking`,
+   time, and who answered);
+4. asks the planner what it would change (`optimise="preview"`, the default) and shows it in
+   `client.multichat.last.changes` and on the `multichat` logger, without changing what you send;
+5. with Anthropic prompt caching and `keepalive=` on, schedules the cache keep-alive on the queue
+   and cancels it when your next turn starts.
+
+Nothing is routed through multiChat: the request goes from your process to the provider.
+
+## Install
+
+```sh
+pip install "multichat-sdk[openai]"      # or [anthropic], or [all]
+```
+
+Python 3.9+. The import name is `multichat`. (An unrelated PyPI package called `multichat`
+installs the same import name; do not install both.)
+
+## Sign in
+
+- `MULTICHAT_API_KEY`: an API key from the portal (for servers and CI), or
+- `multichat login` (or `python -m multichat login`): signs in through the portal in your browser
+  and saves a token to `~/.multichat/credentials.json` (mode 0600).
+
+`multichat_api_key=` on the client wins over both. multiChat never breaks your app: without a
+credential, or when the multiChat account is invalid or out of credit (the store answers 401, 402
+or 403), the client calls the provider directly and records nothing, with one warning on the
+`multichat` logger. `record=False` does the same on purpose (failover still works). Only the
+explicit multiChat calls (`advice`, `spend`, `files`, forks) raise `NotLoggedInError`. Service addresses: `MULTICHAT_STORE_URL`, `MULTICHAT_QUEUE_URL`, `MULTICHAT_PLANNER_URL`.
+
+## Conversations
+
+Calls are grouped by their message lists: a call whose messages start with what a conversation
+recorded (or, for a trimmed history, contain its last reply) continues it; anything else starts a
+new session. To be explicit:
+
+```python
+conv = client.multichat.conversation()            # or conversation("<session ID>") to continue one
+client.chat.completions.create(model=..., messages=msgs, conversation=conv)
+print(conv.session_id, conv.turn)
+```
+
+`client.multichat.last` is the last turn's `TurnInfo`: `session_id`, `turn`, `model`,
+`answered_by`, `usage`, `ms`, `sent` (the body that went to the provider), `changes`, `x`, `y`.
+`client.multichat.flush()` waits until the store has everything; `close()` and `with` do it too.
+
+## Optimise
+
+- `optimise="preview"` (default): the planner's proposal (model on the flip ladder, compaction,
+  cache markers, with the X vs Y cost) is fetched after each turn and shown; nothing changes.
+- `optimise=True`: the turn is stored first and the assembled request from the store is sent
+  instead of yours (`TurnInfo.sent` and `changes` show exactly what and why). If the store is
+  unreachable, your own request goes.
+- `optimise=False`: no planner call.
+
+Set it on the client or per call (`create(..., optimise=True)`).
+
+## Advice and guardrails
+
+```python
+from multichat import OpenAI, Guardrails, GuardrailError
+client = OpenAI(guardrails=Guardrails(max_session_usd=2.0, max_turn_usd=0.25, max_context_tokens="session"))
+advice = client.multichat.advice()        # {spend, findings: [{title, cost_usd, saving_usd, fixes}]}
+for fix in advice["findings"][0]["fixes"]:
+    client.multichat.apply_fix(fix)       # an SDK option, or a fork with better settings
+```
+
+A limit passed raises `GuardrailError` before the provider is called (`on_limit="warn"` sends
+anyway). `stable_tools=True` sorts tools by name so an order change does not break the prompt
+cache. Details: `docs/v2/advice.md`.
+
+## Failover
+
+```python
+from multichat import OpenAI, Anthropic, Backup
+
+client = OpenAI(failover=Backup(client=Anthropic(), model="claude-sonnet-4-5", after_ms=3000))
+r = client.chat.completions.create(model="gpt-5.1", messages=msgs)   # always a ChatCompletion
+```
+
+- The primary starts at once. If it has sent no token after `after_ms`, the backup starts too;
+  the first to answer is used. A rate limit, overload (429, 529, 503...), timeout or connection
+  failure starts the backup at once; other errors (a bad request, a bad key) are raised as they are.
+- The request is converted locally (OpenAI and Anthropic messages, images, documents, tool calls
+  and tool results; `convert="service"` uses the planner's `/v2/convert`), and the answer comes back
+  in the primary's shape: a `ChatCompletion` for OpenAI, a `Message` for Anthropic, or their
+  stream events when you streamed (the backup's answer then arrives whole as a short stream).
+- Per call: `create(..., failover=Backup(...))`, or `failover=None` to turn it off.
+- `Backup(params={"max_tokens": 1024})` adds fields for the backup only. Sampling settings
+  (`temperature`, `top_p`) are not carried to Anthropic, whose current models do not take them.
+- Queue mode: `Backup(..., mode="queue", key_mode="held")` asks the multiChat queue to send the
+  backup at `after_ms` with your backup key (held encrypted, deleted once fired), or
+  `key_mode="webhook", webhook="https://..."` to have your endpoint send it. The primary's first
+  token cancels it. If the queue cannot be reached the in-process timer is used.
+
+## Keep-alive (Anthropic)
+
+```python
+client = Anthropic(keepalive=KeepAlive())           # or keepalive=True
+```
+
+When a request carries `cache_control`, the queue sends the exact request again (`max_tokens=1`)
+at send time + TTL - 30 s (TTL 5 minutes, or 1 hour), and again a TTL later while the session's
+enhanced cache extensions last (the queue keeps the count, so a chain never goes past what the
+session allows), so the cache is warm for your next turn; that turn cancels the chain. A client
+pointed at another deployment (`base_url`) has its keep-alives and queue-mode backups sent there. The queue needs your key: it is held
+encrypted until the task fires (`key_mode="held"`), or use `key_mode="webhook"`. Off by default.
+
+## Keeping the official client
+
+```python
+import multichat, openai
+
+client = openai.OpenAI()
+messages = multichat.messages(client=client)          # a list the official client takes as is
+messages.add_prompt("Describe this", images=["https://example.com/cat.jpg"])
+r = client.chat.completions.create(model="gpt-5.1", messages=messages)
+messages.add_response(r)                              # appended and recorded
+```
+
+- `Session(client, model=..., optimise=..., session_id=...)`: one conversation in the store.
+- `Messages(session)`: the session's messages in the client's format (Anthropic's `system` kept
+  in `messages.system`); `add_system`, `add_prompt(text, images=, documents=)`, `add_response(r)`,
+  `add_tool_result(call_id, output)`, `render("anthropic")` for the other provider.
+- `Model(name, session)`: the name to send; with `optimise=True` the planner's model for the turn.
+- `turn(session, failover=...)`:
+
+```python
+async with multichat.turn(session, failover=multichat.Backup(client=claude, model="claude-sonnet-4-5")) as t:
+    t.messages.add_prompt("And in French?")
+    r = await t.call(client.chat.completions.create)      # calls with t.model and t.messages, records the reply
+```
+
+`t.add_response(r)` records a reply you got yourself. A turn that closes without a recorded
+reply warns (`RuntimeWarning`).
+
+## Workspace (run_code)
+
+Give the model a private workspace per conversation: Python or bash, a `/work` folder kept for 24
+hours, the account's files in (`files_in`) and every file the run makes saved to the account's
+files. Answer its `run_code` calls with `Workspace.handle`:
+
+```python
+from multichat import OpenAI, Workspace, workspace
+
+client = OpenAI()
+ws = Workspace()                                 # MULTICHAT_WORKSPACE_URL overrides the address
+reply = client.chat.completions.create(model="gpt-5.1", messages=msgs, tools=[workspace.openai_tool()])
+for call in reply.choices[0].message.tool_calls or []:
+    if call.function.name == workspace.TOOL_NAME:
+        result = ws.handle(session_id, call.function.arguments)   # the tool result text
+```
+
+`workspace.anthropic_tool()` for Anthropic. The call and its result are recorded with the next
+turn, like any tool call. Details: `docs/v2/workspace.md`.
+
+## Files
+
+Your files live in your account's regional bucket; conversations hold a reference (`mcfile:<id>`),
+and the store gives providers a short-lived signed link, or the bytes inline for a provider that
+does not fetch links.
+
+```python
+f = client.multichat.files.upload("chart.png", session=client.multichat.last.session_id)
+url = client.multichat.files.link(f["id"], ttl=600)["url"]      # at most 7 days
+client.multichat.files.save_to_project(f["id"], "launch")        # kept when the chat is deleted
+```
+
+Inline images, audio and documents in your requests still go to the provider exactly as written;
+the store records the uploaded file's reference instead of the bytes (`record_files=False` keeps the
+bytes). A file tied to a conversation is deleted with it unless saved to a project.
+
+## Conversion
+
+`multichat.convert_request(req, "openai.chat", "anthropic.messages", model)` and
+`multichat.convert_response(resp, from_format, to_format)` are the converters failover uses.
+
+## Tests
+
+```sh
+uv run pytest
+```
+
+Unit tests only: the services are an in-memory transport and the providers are fake servers
+behind the official clients' own mock transport. Nothing reaches a network or a provider.
+
+## Licence
+
+Apache License 2.0: see `LICENSE`, with the attribution notices in `NOTICE`.
+Copyright 2026 Digital Deep Ltd.