PHPackages                             tippiti/api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. tippiti/api-client

ActiveLibrary[API Development](/categories/api)

tippiti/api-client
==================

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

v1.0.2(3mo ago)00MITPHP ^8.1

Since Apr 25Compare

[ Source](https://github.com/tippiti/tippiti-php)[ Packagist](https://packagist.org/packages/tippiti/api-client)[ Docs](https://tippiti.io)[ RSS](/packages/tippiti-api-client/feed)WikiDiscussions Synced 3w ago

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

Tippiti PHP Client
==================

[](#tippiti-php-client)

Official PHP client for the [Tippiti](https://tippiti.io) API – the transcription and dictation platform for physicians, attorneys, forensic examiners and professional typing services.

- **Interactive API docs:** [apidocs.tippiti.io](https://apidocs.tippiti.io)
- **OpenAPI specification:** [tippiti/openapi](https://github.com/tippiti/openapi)
- **Platform:** [tippiti.io](https://tippiti.io)
- **Support:** [app.tippiti.io/support/create](https://app.tippiti.io/support/create)

Framework-agnostic. Built on [Guzzle](https://docs.guzzlephp.org/) and PSR-7 / PSR-18. Runs in Laravel, Symfony, Slim or plain PHP.

Installation
------------

[](#installation)

```
composer require tippiti/api-client
```

Requires PHP 8.1 or newer. Pulls Guzzle as its default HTTP client.

Quick start
-----------

[](#quick-start)

```
use Tippiti\Api\Tippiti;
use Tippiti\Api\Generated\Api\DictationApi;

$config = Tippiti::configure(token: getenv('TIPPITI_TOKEN'));
$dictations = new DictationApi(config: $config);

$response = $dictations->dictationIndex(include_notes: true);

foreach ($response->getData() as $dictation) {
    echo $dictation->getId() . ': ' . $dictation->getTitle() . PHP_EOL;
}
```

Every endpoint, request body, parameter and response is typed, derived directly from the OpenAPI specification at [apidocs.tippiti.io](https://apidocs.tippiti.io).

Authentication
--------------

[](#authentication)

`Tippiti::configure()` configures Bearer-token authentication against `https://app.tippiti.io/api`. 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
------------

[](#resource-ids)

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

```
$dictation = $dictations->dictationShow(dictation: 'aid-xyz12345');
```

Raw integer IDs are rejected with a `404` response.

Available Api classes
---------------------

[](#available-api-classes)

After installation, every API group has a dedicated class under `Tippiti\Api\Generated\Api\*Api`:

```
use Tippiti\Api\Generated\Api\DictationApi;
use Tippiti\Api\Generated\Api\AccountApi;
use Tippiti\Api\Generated\Api\FolderApi;
use Tippiti\Api\Generated\Api\InstructionSetApi;
use Tippiti\Api\Generated\Api\SubUserApi;
// ...
```

Method names follow the operationIds from the specification: `dictationIndex`, `dictationStore`, `dictationShow`, `folderIndex`, `accountUpdate` and so on. See [apidocs.tippiti.io](https://apidocs.tippiti.io) for the full operation list.

Response envelope
-----------------

[](#response-envelope)

Successful responses expose `getSuccess(): bool` and `getData(): mixed` accessors. Failure responses throw `Tippiti\Api\Generated\ApiException` containing the HTTP status code, the decoded response body and the response headers. Validation failures produce `ApiException` with status `422` and per-field error messages. Rate-limit breaches produce `ApiException` with status `429` and a `Retry-After` header.

```
use Tippiti\Api\Generated\ApiException;

try {
    $response = $dictations->dictationShow(dictation: 'aid-xyz12345');
} catch (ApiException $e) {
    fwrite(STDERR, "HTTP {$e->getCode()}: {$e->getMessage()}\n");
    print_r($e->getResponseBody());
}
```

Custom base URL
---------------

[](#custom-base-url)

```
$config = Tippiti::configure(
    token: '...',
    baseUrl: 'https://staging.app.tippiti.io/api',
);
```

Custom HTTP client
------------------

[](#custom-http-client)

Pass your own Guzzle-compatible client to any Api constructor – useful for custom timeouts, proxies, HTTP/2 tuning, or middleware:

```
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;

$stack = HandlerStack::create();
// add your middleware
$http = new Client(['handler' => $stack, 'timeout' => 30]);

$dictations = new DictationApi(client: $http, config: $config);
```

Versioning
----------

[](#versioning)

This client follows [Semantic Versioning](https://semver.org). A release note in [CHANGELOG.md](CHANGELOG.md) accompanies every version. Breaking changes to the underlying API produce a major version bump of this package.

License
-------

[](#license)

[MIT](LICENSE). The Tippiti platform, trademarks and data are not covered by this license.

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance82

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

90d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/278735386?v=4)[Tippiti](/maintainers/tippiti)[@tippiti](https://github.com/tippiti)

---

Tags

phpopenapiapi clientTranscriptiontippitidictationmedical-transcriptionlegal-transcription

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/tippiti-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/tippiti-api-client/health.svg)](https://phpackages.com/packages/tippiti-api-client)
```

###  Alternatives

[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

293.1k](/packages/eslazarev-wildberries-sdk)[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.2k543.5M2.7k](/packages/aws-aws-sdk-php)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.7k409.0k6](/packages/theodo-group-llphant)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[php-opencloud/openstack

PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi

2302.4M25](/packages/php-opencloud-openstack)[oat-sa/tao-core

TAO core extension

65143.7k124](/packages/oat-sa-tao-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)