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.8.0.tar.gz (121.3 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.8.0-py3-none-any.whl (331.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arbi-1.8.0.tar.gz
  • Upload date:
  • Size: 121.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.8.0.tar.gz
Algorithm Hash digest
SHA256 2f15c1714048f345e18518ea437c81761a860b260f6a5f5beb439a23e444fe15
MD5 078fe3a71f8293459b49e019d84f40b7
BLAKE2b-256 1103eb0ab8ef3ee942deeb3c26fed692becc3af2f1255a4da799b237f522af86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arbi-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 331.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53b987096f5364ee04f939dbbac3c27150f0bb5863041631a59d667aeb71202e
MD5 5cf3aaa6ef2b78600f570af548d60edd
BLAKE2b-256 bfcac75190ed4aa3002e64206cdf84f95cdac7bb430738e43de062470d0038c6

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