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.26.2.tar.gz (174.6 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.26.2-py3-none-any.whl (470.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arbi-1.26.2.tar.gz
  • Upload date:
  • Size: 174.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.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.26.2.tar.gz
Algorithm Hash digest
SHA256 cbe571359886d9b6c36c424e75afe1dc213a7e94e915db52b08ce8e0dddd81a9
MD5 029b5ce7aee4bc4772f07d19def63be1
BLAKE2b-256 70319b6a26ccaa81cecabbc886d8e45153f7d2ce66d0bdd0c8658a9c3dfec9e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arbi-1.26.2-py3-none-any.whl
  • Upload date:
  • Size: 470.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.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.26.2-py3-none-any.whl
Algorithm Hash digest
SHA256 81dc6bc069cc74b918e0644e260614d33a5b4df091c04a34ba16539e8bbcd34f
MD5 c249dcd9a99dc4a417e95fd8db212ff6
BLAKE2b-256 d25c566b685930c83ea3791fd45eb58fa14f5207b483ec39a2574dbbb94252ac

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