Omnidapter API client SDK
Project description
omnidapter-sdk
Python client for the Omnidapter API.
Omnidapter lets you connect to your users' calendars (and other services) through a single unified API. You create a link token, send the user through the Connect UI to authorise their account, and then read their data using the connection that comes back.
Installation
pip install omnidapter-sdk
Requires Python 3.10+.
Getting started
Create a client with your API key and the base URL of your Omnidapter instance:
from omnidapter_sdk import OmnidapterClient
client = OmnidapterClient(
base_url="https://api.example.com",
api_key="omni_live_...",
)
All methods are synchronous and return typed response objects. The actual payload is always on .data.
Providers
Providers are the services Omnidapter can connect to (e.g. Google, Microsoft). You typically list them once to populate a picker in your UI.
providers = client.providers.list_providers()
for provider in providers.data:
print(provider.key, provider.display_name)
# Fetch a single provider by its key
google = client.providers.get_provider(provider_key="google")
print(google.data.display_name)
Connections
A connection represents an authorised link between one of your end users and a provider. Once a user completes the Connect flow, their connection appears here.
# List all connections, optionally filtering by status or provider
connections = client.connections.list_connections(status="active", provider="google")
for conn in connections.data:
print(conn.id, conn.provider_key, conn.status)
# Fetch a single connection
conn = client.connections.get_connection(connection_id="conn_...")
print(conn.data.status)
# Revoke a connection — this also invalidates any stored credentials
client.connections.delete_connection(connection_id="conn_...")
Link tokens
A link token is a short-lived, single-use token that grants an end user access to the Connect UI. Generate one server-side, pass it to your frontend, and redirect the user to connect_url. Omnidapter will handle the OAuth flow and create a connection on success.
from omnidapter_sdk.models import CreateLinkTokenRequest
result = client.link_tokens.create_link_token(
create_link_token_request=CreateLinkTokenRequest(
end_user_id="user_123", # your internal user ID
allowed_providers=["google", "microsoft"], # restrict which providers are shown
)
)
token = result.data
print(token.token) # lt_... — pass this to your frontend
print(token.connect_url) # redirect the user here to start the Connect flow
print(token.expires_at) # datetime — tokens are short-lived, generate them on demand
Calendar
Once a user has a connection, you can read their calendar data. All calendar operations require a connection_id.
from datetime import datetime, timezone
# List the calendars available on a connection
calendars = client.calendar.list_calendars(connection_id="conn_...")
for cal in calendars.data:
print(cal.id, cal.name)
# List events within a time range across a specific calendar
events = client.calendar.list_events(
connection_id="conn_...",
calendar_id="cal_...",
start=datetime(2026, 4, 1, tzinfo=timezone.utc),
end=datetime(2026, 4, 30, tzinfo=timezone.utc),
)
for event in events.data:
print(event.id, event.title, event.start)
Error handling
The SDK raises ApiException for any non-2xx response. You can inspect the HTTP status code and the raw response body to handle errors appropriately.
from omnidapter_sdk.exceptions import ApiException
try:
conn = client.connections.get_connection(connection_id="conn_unknown")
except ApiException as e:
print(e.status) # e.g. 404
print(e.body) # JSON error body from the server
Notes
- The SDK is generated from the server's OpenAPI spec via
scripts/generate_sdks.sh. Run that script after pulling changes to regenerate the client code.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file omnidapter_sdk-0.4.1.tar.gz.
File metadata
- Download URL: omnidapter_sdk-0.4.1.tar.gz
- Upload date:
- Size: 44.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
375f71cc96605a13374cb1b8f63841762df6dba0cd9a0dee424bf40959afb774
|
|
| MD5 |
7fcb076d0d08104211dcea75bdb817cd
|
|
| BLAKE2b-256 |
cf179062754a0943fa635784f6210a50d1961785e3e799471b2b940e9c3369e2
|
File details
Details for the file omnidapter_sdk-0.4.1-py3-none-any.whl.
File metadata
- Download URL: omnidapter_sdk-0.4.1-py3-none-any.whl
- Upload date:
- Size: 116.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b608d5fb2817cafd794d37bda15ffc23dbf1b2aa7f4b4f6a6ba787dcf98a1bcb
|
|
| MD5 |
628c0b4d6593724388af43fcf4e474a9
|
|
| BLAKE2b-256 |
68691d26a1f5fcd411dce0be014d16e7a4e1368f66a2ed1bdee2d62152bdc4cb
|