Skip to main content

Tippiti Python Client

Official Python client for the Tippiti API – the transcription and dictation platform for physicians, attorneys, forensic examiners and professional typing services.

Installation

pip install tippiti

Requires Python 3.10 or newer. Built on httpx with type-annotated request and response models.

Quick start

import os

from tippiti import Tippiti
from tippiti.generated.api.dictation import dictation_index
from tippiti.generated.models.dictation_index_response_200 import (
    DictationIndexResponse200,
)

client = Tippiti.create(token=os.environ["TIPPITI_TOKEN"])

result = dictation_index.sync(client=client, include_notes=True)

if isinstance(result, DictationIndexResponse200):
    for dictation in result.data:
        print(dictation.id, dictation.title)

The .sync() helper returns the parsed payload directly; its return type is a union of all documented response models (DictationIndexResponse200, DictationIndexResponse401, DictationIndexResponse422, …). Narrow with isinstance() before touching model-specific fields, or use .sync_detailed() if you need the raw response (status code, headers, unparsed body). Every endpoint, parameter, and response is typed, derived directly from the OpenAPI specification at apidocs.tippiti.io.

Async variants

Every endpoint also ships an asyncio variant. Swap .sync(...) for .asyncio(...) (or .sync_detailed(...) for .asyncio_detailed(...)):

import asyncio

async def main() -> None:
    result = await dictation_index.asyncio(client=client, include_notes=True)
    if isinstance(result, DictationIndexResponse200):
        for dictation in result.data:
            print(dictation.id, dictation.title)

asyncio.run(main())

Authentication

The client sends your token as a Bearer credential in the Authorization header. Tokens are scoped to the issuing user's permissions (main user or sub-user with the relevant capabilities) and can be created in the account settings.

Resource IDs

All resource identifiers are sqid-encoded strings prefixed with aid-, for example aid-xyz12345. Model fields reflect this – IDs are typed str, never int:

from tippiti.generated.api.dictation import dictation_show

response = dictation_show.sync_detailed(client=client, dictation="aid-xyz12345")

Raw integer IDs are rejected with a 404 response.

Available API modules

After installation, every API group has a dedicated module under tippiti.generated.api.*:

from tippiti.generated.api.dictation import dictation_index, dictation_show, dictation_store
from tippiti.generated.api.folder import folder_index, folder_store
from tippiti.generated.api.account import account_show, account_update
from tippiti.generated.api.instruction_set import instruction_set_index
from tippiti.generated.api.sub_user import sub_user_index
# ...

Module and function names follow the tags and operationIds from the specification. See apidocs.tippiti.io for the full operation list.

Response envelope

.sync() / .asyncio() return a typed dataclass exposing success and either data (success) or message / errors (failure). .sync_detailed() / .asyncio_detailed() wrap that payload in a Response object whose .parsed attribute is typed as a union of all possible status-code responses – use response.status_code to pick the right branch. Validation failures return 422 with per-field error messages. Rate-limit breaches return 429 with a Retry-After header.

Custom base URL

client = Tippiti.create(
    token="...",
    base_url="https://staging.app.tippiti.io/api",
)

Custom httpx configuration

Pass any keyword argument to Tippiti.create(...) and it is forwarded to the underlying httpx client – for example timeout, proxy, or TLS settings:

client = Tippiti.create(
    token="...",
    timeout=30.0,
    follow_redirects=True,
)

Versioning

This client follows Semantic Versioning. A release note in CHANGELOG.md accompanies every version. Breaking changes to the underlying API produce a major version bump of this package.

License

MIT. The Tippiti platform, trademarks and data are not covered by this license.

Metadata

Release files for tippiti 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tippiti 1.0.2
File Size Uploaded Provenance Actions
tippiti-1.0.2.tar.gz 142.1 kB Without provenance Details for tippiti-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tippiti 1.0.2
File Interpreter ABI Platform Actions
tippiti-1.0.2-py3-none-any.whl Python 3 none any Details for tippiti-1.0.2-py3-none-any.whl

Total release size: 922.3 kB

Release files / tippiti-1.0.2.tar.gz

Download URL tippiti-1.0.2.tar.gz
Size 142.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6d1eb4bcad3e753eef1796db91d846e6da41ad12cd84209d8d9c8d81931834b3
BLAKE2b-256 checksum
How to use checksums
4b2383df227c6e52ee972f85b13ad51dac4d628d13af05facfdd0180c703fab0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.7.18

Release files / tippiti-1.0.2-py3-none-any.whl

Download URL tippiti-1.0.2-py3-none-any.whl
Size 780.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dfff96a945270eb584f8053e072636b8f8da190d6b10f24e0a1f63550030ecdd
BLAKE2b-256 checksum
How to use checksums
a3c20e836b212834ce3bf814776745a232c9264bdebda5649d2bb394e7388209
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.7.18

Security for tippiti 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page