Skip to main content

Python client for the ARBI API

Project description

arbi

Official Python client for the ARBI API, auto-generated from the OpenAPI specification.

Installation

pip install arbi

Quick start

from arbi_client import Client, AuthenticatedClient
from arbi_client.api.user import login_user
from arbi_client.models import LoginRequest

# 1. Log in with the unauthenticated client
with Client(base_url="https://your-instance.arbicity.com") as c:
    response = login_user.sync_detailed(
        client=c,
        body=LoginRequest(
            email="user@example.com",
            signature="<base64-ed25519-signature>",
            timestamp=1700000000,
        ),
    )
    login = response.parsed
    token = login.access_token

# 2. Use the JWT for all authenticated requests
with AuthenticatedClient(base_url="https://your-instance.arbicity.com", token=token) as c:
    ...

Login uses Ed25519 signature-based authentication: the client derives a keypair from the user's password, signs email|timestamp, and sends the signature. The server verifies it against the stored public key and returns a JWT. See the ARBI documentation for details on the key derivation and signing process.

Async support

Every endpoint has both sync and async variants:

from arbi_client import AuthenticatedClient
from arbi_client.api.user import get_user_workspaces

async with AuthenticatedClient(base_url="https://your-instance.arbicity.com", token=token) as c:
    workspaces = await get_user_workspaces.asyncio(client=c)

API structure

Each endpoint is a Python module with four functions:

Function Blocking Returns
sync Yes Parsed data or None
sync_detailed Yes Full Response object
asyncio No Parsed data or None
asyncio_detailed No Full Response object

Endpoints are grouped by tag under arbi_client.api:

arbi_client.api.user          # login, register, settings
arbi_client.api.workspace     # workspace management
arbi_client.api.document      # document upload and tagging
arbi_client.api.conversation  # conversations and messages
arbi_client.api.assistant     # AI assistant queries
arbi_client.api.tag           # tag management
arbi_client.api.configs       # configuration management
arbi_client.api.notifications # notification management
arbi_client.api.health        # health checks

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arbi-1.27.0.tar.gz (184.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arbi-1.27.0-py3-none-any.whl (488.3 kB view details)

Uploaded Python 3

File details

Details for the file arbi-1.27.0.tar.gz.

File metadata

  • Download URL: arbi-1.27.0.tar.gz
  • Upload date:
  • Size: 184.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arbi-1.27.0.tar.gz
Algorithm Hash digest
SHA256 a268d865a1b2d3b5980756e9e17569ea1882463a9e0b16459005efc1f48265ef
MD5 2783487999649ad4c581f8fd1bdd1256
BLAKE2b-256 4e6550d933c77c9eafc73aa8effd0e1118779136d83acbbd893b71898e7eba6a

See more details on using hashes here.

File details

Details for the file arbi-1.27.0-py3-none-any.whl.

File metadata

  • Download URL: arbi-1.27.0-py3-none-any.whl
  • Upload date:
  • Size: 488.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arbi-1.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d507b22b5a4d38f26474354832fb0c4804d970294d3bdc39079b44ca42d240c8
MD5 f8d5365dd90aa0ff9268f4550e69cf94
BLAKE2b-256 493ed3b6a3760b29c88452299cc4855bc939abb51a36d19d83c1064b3c990046

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page