vgen-apiamtic SDK
The vgen-apiamtic SDK for Python provides access to the vgen-apiamtic REST APIs from Python applications.
[!TIP] Looking for a specific signature, model, enum, or error type? This SDK ships a generated SDK map -- a lookup index of the SDK's entire Python surface. Consult it before scanning the source tree; details under SDK map.
Installation
Install the Python SDK from PyPI, with whichever package manager your project uses:
pip install vgen-apiamtic
uv add vgen-apiamtic
poetry add vgen-apiamtic
Quick Start
Synchronous client
Construct VgenApiamticClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.
from vgen_apiamtic import VgenApiamticClient
client = VgenApiamticClient(bearer_auth="YOUR_BEARER_TOKEN")
# TODO: call endpoints here -- see api-reference.md
client.close()
Alternatively, scope it -- with VgenApiamticClient(...) as client: closes the pool on exit; see Best Practices.
Client is exported as an alias of VgenApiamticClient, so from vgen_apiamtic import Client also works.
The SDK accepts every model-typed input in two interchangeable spellings, both type-checked: the typed model, or a plain dict with the same keys -- the OrDict and Model | ModelDict unions in the SDK map. Pick whichever suits the call site: the dict form needs no import, while the model form adds a keyword-checked constructor and editor completion.
Asynchronous client
AsyncVgenApiamticClient mirrors VgenApiamticClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences -- for example, the transport argument is custom_async_http_client.
from asyncio import run
from vgen_apiamtic import AsyncVgenApiamticClient
async def main() -> None:
client = AsyncVgenApiamticClient(bearer_auth="YOUR_BEARER_TOKEN")
# TODO: call endpoints here, awaiting each -- see api-reference.md
await client.aclose()
run(main())
Alternatively, scope it -- async with AsyncVgenApiamticClient(...) as client: closes the pool on exit. Only the async spelling is aclose, matching httpx; see Best Practices.
AsyncClient is the exported alias. Each client accepts only its own transport argument; passing the other's is a TypeError at runtime and an error under mypy.
Usage
Two generated references cover the SDK; each answers a different question:
| Reference | For |
|---|---|
| API Reference | Usage guidance for a single parsed operation: client.<group>.<operation>(...) returns the typed payload and raises ApiError on any non-2xx, with .error the typed error body, or RawError for a status the operation does not document. |
| Raw API Reference | The same for the raw variant: client.<group>.with_raw_response.<operation>(...) returns ApiResult[T, E] and never raises for an API error. |
Both API references carry every one of the 59 operations, with a sync and an async sample and a parameter table each.
SDK map
This SDK ships a generated SDK map -- sdk-map.md -- a deterministic, lookup-oriented table of contents of the SDK's Python surface, generated by APIMatic alongside this SDK.
Consult the map before scanning or grepping the source: it answers call-level contract questions by lookup, and for anything it does not carry -- model shapes, enum values, an endpoint's route or behavioural prose -- it names the one source file to read. How to read the map itself, including the SDK-wide defaults its rows rely on, is stated at the top of sdk-map.md.
Best Practices
[!TIP] Use a single
VgenApiamticClientinstance for the lifetime of your application and reuse it across all requests. Each instance owns its own connection pool, so an instance per request forfeits connection reuse and leaks pools that are never closed.
Match the disposal to the client's lifetime: an application-lifetime client is closed once at shutdown with close() / aclose(); where the lifetime fits a block, with VgenApiamticClient() as client: / async with AsyncVgenApiamticClient() as client: releases it automatically. Both are idempotent, but a closed client is not reusable: the next call raises. The client closes whatever transport it holds, including one you supplied via custom_http_client / custom_async_http_client; if you intend to reuse your own transport across clients, don't hand its lifetime to a with block.
License
This SDK is distributed under the MIT License.
Support
Refer to the API reference for detailed information on available operations with code samples.
Metadata
Release files for vgen-apiamtic 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vgen_apiamtic-0.0.1.tar.gz | 152.9 kB | Without provenance | Details for vgen_apiamtic-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vgen_apiamtic-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for vgen_apiamtic-0.0.1-py3-none-any.whl |
Total release size: 419.1 kB
Release files / vgen_apiamtic-0.0.1.tar.gz
| Download URL | vgen_apiamtic-0.0.1.tar.gz |
|---|---|
| Size | 152.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
942692773f39b99f161448feecd0501994fdd3c217fe05823c185a08a960fa45
|
|
BLAKE2b-256 checksum How to use checksums |
33f257b0cf2517cccb2f3c1db09b10dbaa8f57b5dc5851e0893d4b5daea37cf7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / vgen_apiamtic-0.0.1-py3-none-any.whl
| Download URL | vgen_apiamtic-0.0.1-py3-none-any.whl |
|---|---|
| Size | 266.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d7159e0849fc6b0e990a941bb6d8256412318382258a97d9f5a99de4baa3eea
|
|
BLAKE2b-256 checksum How to use checksums |
522d4711531bd131e7011137945fd9a0971ca5885cda14f0bff09113e0efc6da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for vgen-apiamtic 0.0.1
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.