based-models-agentloop
based-models-agentloop is a small, synchronous Python library for building reliable,
tool-using LLM agents without tying application code to one provider. The package supplies
the agent loop, typed conversations, provider adapters, tool execution, retries, and
observability while leaving prompts, application state, approval policy, and secrets under
your control.
The package is installed as based-models-agentloop and imported as agentloop.
Why use agentloop?
- Use the same agent code with Anthropic, OpenAI, OpenRouter, or Modal/vLLM.
- Run local Python tools or provider-hosted web search.
- Keep complete, typed, serializable transcripts—including tool activity, sources, and citations.
- Execute independent tool calls concurrently while preserving their original result order.
- Get provider-independent retries, errors, usage data, and lifecycle limits.
- Add console output, custom observers, or OpenTelemetry tracing without changing the loop.
- Test agent behavior offline with the included scripted
FakeClient. - Install only the provider dependencies your application needs.
Requires Python 3.12 or newer.
Quick start
Install the extra for your provider. For example, to use OpenAI:
pip install "based-models-agentloop[openai-compat]"
export LLM_PROVIDER=openai
export OPENAI_API_KEY="..."
Then create and run an agent:
import os
from agentloop import Agent
with Agent.from_env(
os.environ,
tools=[],
system="Answer clearly and concisely.",
) as agent:
print(agent.run("Why is the sky blue?"))
Agent.from_env() receives an environment mapping explicitly—the library never reads the
process environment or loads a .env file on its own. The context manager closes the client
created by from_env() when the block exits.
Installation options
| Extra | Adds |
|---|---|
anthropic |
The Anthropic SDK |
openai-compat |
httpx support for OpenAI, OpenRouter, and Modal/vLLM |
otel |
The OpenTelemetry SDK and OTLP HTTP exporter |
all |
Every optional integration above |
pip install "based-models-agentloop[anthropic]"
pip install "based-models-agentloop[openai-compat]"
pip install "based-models-agentloop[otel]"
pip install "based-models-agentloop[all]"
Provider dependencies are imported lazily, so importing agentloop does not require every
optional SDK.
Providers
Configuration selects the provider; application and tool code stay the same.
| Provider | API | Local tools | Hosted web search |
|---|---|---|---|
| Anthropic | Messages | Yes | Yes |
| OpenAI | Responses (default) | Yes | Yes |
| OpenAI | Chat Completions compatibility | Yes | No |
| OpenRouter | OpenAI-compatible Chat Completions | Yes | No |
| Modal/vLLM | OpenAI-compatible Chat Completions | Yes | No |
All adapters normalize requests, responses, token usage, stop reasons, transcripts, and
provider failures into shared types. OpenAI uses the Responses API by default; set
OPENAI_API=completions only when Chat Completions compatibility is required.
Local Python tools
The @tool decorator pairs a Python handler with an explicit JSON Schema. The schema is the
contract shown to the model and is never inferred from the function signature.
import os
from agentloop import Agent, ToolError, tool
ADD_SCHEMA = {
"type": "object",
"properties": {
"left": {"type": "integer"},
"right": {"type": "integer"},
},
"required": ["left", "right"],
"additionalProperties": False,
}
@tool(parameters=ADD_SCHEMA)
def add(left: int, right: int) -> str:
"""Add two integers."""
if abs(left) > 1_000_000 or abs(right) > 1_000_000:
raise ToolError("numbers must be at most one million")
return str(left + right)
with Agent.from_env(
os.environ,
tools=[add],
system="Use the add tool for arithmetic.",
) as agent:
print(agent.run("What is 27 plus 15?"))
ToolError returns safe feedback to the model. Unexpected exceptions are logged and
converted into error results so every tool call still receives a matching result.
Subclass Deps when tools need trusted application state such as a database client, tenant
identifier, or request context. A before_tool approval hook can allow or deny each call
before execution. Independent calls run concurrently, up to eight at a time, while results
retain the model's original call order.
Provider-hosted web search
Hosted tools run inside the model provider rather than in your Python process. Native web search is supported by Anthropic and by OpenAI's Responses API:
import os
from agentloop import Agent, HostedTool
search = HostedTool(
kind="web_search",
options={
"allowed_domains": ["europa.eu"],
"search_context_size": "high",
},
)
with Agent.from_env(os.environ, tools=[search]) as agent:
print(agent.run("What changed in EU AI Act guidance this month?"))
Search activity, consulted sources, and citations are preserved in the transcript. Passing a hosted tool to an unsupported provider or API fails when the agent is constructed instead of silently dropping the capability.
Conversations and transcripts
Use run() for a single prompt when only the final text matters. Use converse() when the
application needs the complete history or a multi-turn conversation:
import os
from agentloop import Agent, Transcript, final_text
transcript = Transcript()
with Agent.from_env(os.environ, tools=[]) as agent:
transcript.add_user_message("My name is Ada.")
agent.converse(transcript)
transcript.add_user_message("What is my name?")
agent.converse(transcript)
print(final_text(transcript))
print(transcript.model_dump_json(indent=2))
A transcript can contain text, model thinking, local tool calls and results, hosted-tool activity, sources, and citations. It can be serialized to JSON or JSONL and restored later. Provider-origin data is retained where exact replay is required, while the canonical parts remain readable to application code.
For manually assembled or restored conversations, check_invariants() verifies tool-call
IDs, result adjacency, completeness, and whether the transcript is safe to send.
Reliability and errors
Agents built with Agent.from_env() receive the configured retry policy automatically.
Rate limits, provider unavailability, timeouts, and invalid responses are retryable;
authentication, bad-request, context-length, missing-model, and credit errors fail
immediately. Server Retry-After values are honored within the configured delay limit.
import os
from agentloop import Agent, AgentLoopError
from agentloop.errors import AuthError, RateLimited
try:
with Agent.from_env(os.environ, tools=[]) as agent:
print(agent.run("Hello"))
except AuthError:
print("Check provider credentials")
except RateLimited as error:
print("The provider remained rate limited", error.retry_after)
except AgentLoopError as error:
print(f"Agent failed: {type(error).__name__}: {error}")
The loop also enforces iteration and wall-clock budgets, protects against truncated tool calls, and validates that every tool call receives exactly one result.
Observability
Observers receive request, response, retry, and tool lifecycle events without changing agent
behavior. ConsoleObserver provides readable local output, ListObserver records events for
tests and debugging, and MultiObserver combines observers.
Install the otel extra to emit OpenTelemetry spans for conversations, model requests,
tools, and retries. Prompt and tool content is not captured by tracing unless the application
explicitly enables it.
Testing and custom providers
agentloop.providers.fake.FakeClient replays scripted responses and records every request it
receives. It requires no network, provider account, mocking library, or optional SDK, making
agent-loop tests deterministic.
Custom integrations implement the small LLMClient protocol:
namemodelcomplete(request) -> ModelResponse
The provider seam contains no vendor SDK types, so a custom client can be used directly with
Agent and the rest of the package.
Configuration
| Variable | Default | Purpose |
|---|---|---|
LLM_PROVIDER |
anthropic |
anthropic, openai, openrouter, or modal |
LLM_MAX_ATTEMPTS |
3 |
Total attempts, including the first request |
ANTHROPIC_API_KEY |
unset | Anthropic credential |
ANTHROPIC_MODEL |
claude-opus-5 |
Anthropic model |
OPENAI_API_KEY |
unset | OpenAI credential |
OPENAI_MODEL |
gpt-5.1 |
OpenAI model |
OPENAI_API |
responses |
responses or completions |
OPENROUTER_API_KEY |
unset | OpenRouter credential |
OPENROUTER_MODEL |
openrouter/free |
OpenRouter model or router |
MODAL_ENDPOINT_URL |
unset | Base URL of a deployed Modal/vLLM endpoint |
MODAL_ENDPOINT_MODEL |
Qwen/Qwen3.6-35B-A3B-FP8 |
Model exposed by the endpoint |
MODAL_PROXY_TOKEN_ID |
unset | Optional Modal proxy token ID |
MODAL_PROXY_TOKEN_SECRET |
unset | Optional Modal proxy token secret |
Settings can also be constructed directly when configuration comes from a secrets service
or another application-owned source.
Documentation
Full documentation and examples are coming soon.
Stability and license
based-models-agentloop is currently beta software. While the version is 0.x, a minor
release may change the public API exposed through agentloop.__all__.
Licensed under the Apache License 2.0.
Metadata
Release files for based-models-agentloop 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| based_models_agentloop-0.4.0.tar.gz | 47.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| based_models_agentloop-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 108.6 kB
Release files / based_models_agentloop-0.4.0.tar.gz
| Download URL | based_models_agentloop-0.4.0.tar.gz |
|---|---|
| Size | 47.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73d373b74eeee80ba58b20a8a8e0431080aa81e8d52218116aef61bfa0dcff3f
|
|
BLAKE2b-256 checksum How to use checksums |
8d89a92e2660e1638a5f7ed04922f9bb95db03cec3cdc75c1b7ad46da5517784
|
| 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 Oct 1, 2026.
Transparency logRelease files / based_models_agentloop-0.4.0-py3-none-any.whl
| Download URL | based_models_agentloop-0.4.0-py3-none-any.whl |
|---|---|
| Size | 60.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f65efd90f397aa909bb8716e57944654b035cd6a63d345748aed5e757930d6d1
|
|
BLAKE2b-256 checksum How to use checksums |
3f8f6eab46226ce39691f9daf3152f2fcef70e408258a07b16255ff810a7a138
|
| 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 Oct 1, 2026.
Transparency log