Client libraries

Rhetoric publishes official client libraries for TypeScript, Python, and Rust. Each one exposes every operation in the API reference with typed inputs and outputs, so you can call Rhetoric without hand-writing HTTP requests. They are meant to be used on your backend, where your API key lives.

Language	Package	Registry
TypeScript	`@rhetoriclabs/rhetoric`	npm
Python	`rhetoric_py`	PyPI
Rust	`rhetoric`	crates.io

Install

npm install @rhetoriclabs/rhetoric

pip install rhetoric_py

cargo add rhetoric

The Python package is installed as rhetoric_py but imported as rhetoric.

Create a client

Every client takes the API URL and an API key. Keep the key on your backend.

import { RhetoricClient } from "@rhetoriclabs/rhetoric";

const client = new RhetoricClient({
  url: "https://api.rhetoric.law",
  token: process.env.RHETORIC_API_KEY,
});

import os

from rhetoric import RhetoricClient

client = RhetoricClient(
    url="https://api.rhetoric.law",
    token=os.environ["RHETORIC_API_KEY"],
)

use rhetoric::RhetoricClient;

let client = RhetoricClient::new(
    "https://api.rhetoric.law",
    std::env::var("RHETORIC_API_KEY")?,
);

Make a request

Operations are methods on the client. This example creates a filer and then starts a filing session for them.

const { filer } = await client.createFiler({});

const { session, sessionToken } = await client.createFilingSession({
  filerId: filer.id,
});

from rhetoric import CreateFilerInput, CreateFilingSessionInput

# The Python client is async. Run this inside a coroutine.
out = await client.create_filer(CreateFilerInput())

out = await client.create_filing_session(
    CreateFilingSessionInput(filer_id=out.filer.id)
)
session, session_token = out.session, out.session_token

use rhetoric::{CreateFilerInput, CreateFilingSessionInput};

let req = CreateFilerInput {};
let filer = client.create_filer(req).await?.filer;

let req = CreateFilingSessionInput { filer_id: filer.id };
let out = client.create_filing_session(req).await?;
let (session, session_token) = (out.session, out.session_token);

The session token is only returned once, at creation time. Pass it to your frontend so the Element can drive the session.

Error handling

Each library reports failures in the way that is idiomatic for its language:

TypeScript throws an error when an operation fails.
Python raises an exception when an operation fails.
Rust returns an Err when an operation fails.

Command line

If you would rather explore the API from a terminal, the Rhetoric CLI exposes the same operations as commands.

Guides

Element

API Reference

CLI Reference

Install

Create a client

Make a request

Error handling

Command line

​Install

​Create a client

​Make a request

​Error handling

​Command line

Install

Create a client

Make a request

Error handling

Command line