Framework integrations

pip install langchain-vaquill
export VAQUILL_API_KEY="vq_key_..."

from langchain_openai import ChatOpenAI
from langchain.agents import create_agent

from langchain_vaquill import VaquillToolkit

toolkit = VaquillToolkit(max_credits=100)  # reads VAQUILL_API_KEY
agent = create_agent(ChatOpenAI(model="gpt-4o"), toolkit.get_tools())

result = agent.invoke(
    {"messages": [("user", "Is California Penal Code 187 in force, and what does it say?")]}
)
print(result["messages"][-1].content)
print("credits spent:", toolkit.credits_spent)

VaquillToolkit(tools=["vaquill_search_statutes", "vaquill_get_statute_text"])
VaquillToolkit(free_only=True)
VaquillToolkit.available_tool_names()

from langchain_vaquill import VaquillRetriever

retriever = VaquillRetriever(
    k=3,
    filters={"state": "ca", "corpus_type": ["STATE"], "exclude_repealed": True},
    max_credits=30,
)
docs = retriever.invoke("homicide with malice aforethought")
docs[0].page_content  # section text
docs[0].metadata[
    "citation"
]  # also: id, jurisdiction, sourceUrl, effectiveDate, lastAmendedDate, currentThrough

pip install llama-index-tools-vaquill
export VAQUILL_API_KEY="vq_key_..."

import asyncio

from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI
from llama_index.tools.vaquill import VaquillToolSpec

tool_spec = VaquillToolSpec(max_credits=50)  # key from VAQUILL_API_KEY

agent = FunctionAgent(
    tools=tool_spec.to_tool_list(),
    llm=OpenAI(model="gpt-4.1"),
    system_prompt=(
        "You are a legal research assistant. Find the section with search_statutes or "
        "resolve_citation, then read it with get_section(include_body=true). "
        "Quote the citation and sourceUrl. Each call costs credits, so avoid repeats."
    ),
)


async def main() -> None:
    answer = await agent.run("What does 42 U.S.C. 1983 provide? Quote the first sentence.")
    print(answer)
    print("credits spent:", tool_spec.credits_spent)


asyncio.run(main())

from llama_index.core.query_engine import RetrieverQueryEngine
from llama_index.retrievers.vaquill import VaquillRetriever

retriever = VaquillRetriever(
    similarity_top_k=5,
    filters={"state": "ca", "corpus_type": "STATE"},
    max_credits=40,
)

for hit in retriever.retrieve("elements of first degree murder"):
    print(hit.score, hit.node.metadata["citation"], hit.node.metadata["sourceUrl"])
    print(hit.node.get_content()[:200])

query_engine = RetrieverQueryEngine.from_args(retriever)  # uses your configured LLM

npm install @vaquill-ai/ai-sdk ai zod
export VAQUILL_API_KEY=vq_key_...

import { generateText, isStepCount } from "ai";
import { createVaquillTools } from "@vaquill-ai/ai-sdk";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.5",
  tools: createVaquillTools({ maxCredits: 50 }),
  stopWhen: isStepCount(6),
  prompt: "What is the statute of limitations for medical malpractice in Texas? Cite the section.",
});

import { ToolLoopAgent, isStepCount } from "ai";
import { createVaquillTools } from "@vaquill-ai/ai-sdk";

const researcher = new ToolLoopAgent({
  model: "anthropic/claude-sonnet-4.5",
  instructions:
    "You are a legal research assistant. Verify every citation with resolveCitation before relying on it. " +
    "Quote statute text only from getStatuteSectionText. Never cite a section you did not retrieve. " +
    "If a tool returns spend_limit, stop and answer from what you have.",
  tools: createVaquillTools({
    maxCredits: 100,
    // Read tools only; leave out the expensive ones if you do not need them.
    exclude: ["extractCitations", "listDivisions"],
  }),
  stopWhen: isStepCount(10),
});

const { text } = await researcher.generate({
  prompt: "Compare how California and New York define 'trade secret'.",
});

import { Vaquill } from "@vaquill-ai/sdk";
import { createVaquillTools } from "@vaquill-ai/ai-sdk";

createVaquillTools({
  apiKey: process.env.VAQUILL_API_KEY, // default: process.env.VAQUILL_API_KEY
  client: new Vaquill(), // your own configured Vaquill client (base URL, retries, fetch)
  maxCredits: 100, // hard spend cap, default 200, Infinity to disable
  include: ["searchStatutes", "resolveCitation"], // only these tool names
  exclude: ["extractCitations"], // everything except these (applied after include)
  allowWrites: false, // expose the watch tools, default false
  maxResultChars: 60_000, // replace results larger than this with a preview, default 60000
  redact: ["internal-secret"], // extra strings to scrub from error messages
});

{
  "ok": false,
  "error": {
    "kind": "not_found",
    "message": "...",
    "retryable": false,
    "hint": "Nothing exists at that identifier. Find the right actId ...",
    "status": 404,
    "requestId": "req_..."
  }
}