Vocode Python Library
Documentation
API documentation is available at here.
Installation
Add this dependency to your project's build file:
pip install vocode-api
# or
poetry add vocode-api
Usage
from vocode.client import Vocode
vocode_client = Vocode(
token="YOUR_API_KEY"
)
action_response = vocode_client.actions.get_action(
id="action_id"
);
print(action_response)
Async Client
from vocode.client import AsyncVocode
import asyncio
vocode_client = AsyncVocode(
token="YOUR_API_KEY"
)
async def get_action() -> None:
action_response = vocode_client.actions.get_action(
id="action_id"
);
print(token_response)
asyncio.run(action_response())
Timeouts
By default, the client is configured to have a timeout of 60 seconds. You can customize this value at client instantiation.
from vocode.client import Vocode
vocode_client = Vocode(
token="YOUR_API_KEY",
timeout=15
)
Handling Exceptions
All exceptions thrown by the SDK will sublcass vocode.ApiError.
from vocode.core import ApiError
from vocode import UnprocessableEntityError
try:
vocode_client.actions.get_action(id="action_id");
except UnprocessableEntityError as e:
# handle specific error
except APIError as e:
# handle any api related error
Error codes are as followed:
| Status Code | Error Type |
|---|---|
| 422 | UnprocessableEntityError |
Beta status
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
1 maintainer
Metadata
1 maintainer
Release files for vocode-api 0.0.48
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vocode_api-0.0.48.tar.gz | 52.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vocode_api-0.0.48-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 217.4 kB
Release files / vocode_api-0.0.48.tar.gz
| Download URL | vocode_api-0.0.48.tar.gz |
|---|---|
| Size | 52.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
217718c4d59204368e06da33eecf2f1a66f1b767e15533f11f11ba114d1677f9
|
|
BLAKE2b-256 checksum How to use checksums |
8e0bcb4d65ecb34391d813de6604c70df3ddf2a63ad70d370c59ae7aed246136
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1070-azure
|
Release files / vocode_api-0.0.48-py3-none-any.whl
| Download URL | vocode_api-0.0.48-py3-none-any.whl |
|---|---|
| Size | 165.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7295f43d8def83a00ab773b1bfada762900d4a2f86c8f8da1a081c3b041e3423
|
|
BLAKE2b-256 checksum How to use checksums |
654f8d0418876a30d4261ce66475bdf70f859a3f2c01261d64a53a90deb12546
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1070-azure
|
