Skip to main content

vgen-apimatic SDK

Built with APIMatic License: MIT Python 3.10+

The vgen-apimatic SDK for Python provides access to the vgen-apimatic REST APIs from Python applications.


Installation

Install the Python SDK from PyPI, with whichever package manager your project uses:

pip install vgen-apimatic
uv add vgen-apimatic
poetry add vgen-apimatic

Quick Start

Synchronous client

Construct VgenApimaticClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.

from vgen_apimatic import VgenApimaticClient

client = VgenApimaticClient(bearer_auth="YOUR_BEARER_TOKEN")

# TODO: call endpoints here -- see api-reference.md

client.close()

Alternatively, scope it -- with VgenApimaticClient(...) as client: closes the pool on exit; see Best Practices.

Client is exported as an alias of VgenApimaticClient, so from vgen_apimatic 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

AsyncVgenApimaticClient mirrors VgenApimaticClient 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_apimatic import AsyncVgenApimaticClient


async def main() -> None:
    client = AsyncVgenApimaticClient(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 AsyncVgenApimaticClient(...) 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

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 VgenApimaticClient() as client: / async with AsyncVgenApimaticClient() 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-apimatic 0.0.1

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

Source distribution (sdist)

Source distribution for vgen-apimatic 0.0.1
File Size Uploaded Provenance Actions
vgen_apimatic-0.0.1.tar.gz 152.9 kB Without provenance Details for vgen_apimatic-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vgen-apimatic 0.0.1
File Interpreter ABI Platform Actions
vgen_apimatic-0.0.1-py3-none-any.whl Python 3 none any Details for vgen_apimatic-0.0.1-py3-none-any.whl

Total release size: 419.1 kB

Release files / vgen_apimatic-0.0.1.tar.gz

Download URL vgen_apimatic-0.0.1.tar.gz
Size 152.9 kB
Tags Source
SHA-256 checksum
How to use checksums
cc190b3b6b9c811af917665126c2c48ba37ff5fa375eba94b218f9d32139494d
BLAKE2b-256 checksum
How to use checksums
55b45ef3bde6f66646c8af2d7474100c7e5d2c80d7bc2ec5a1dc284988c02b02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / vgen_apimatic-0.0.1-py3-none-any.whl

Download URL vgen_apimatic-0.0.1-py3-none-any.whl
Size 266.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
537d7ca3e85fb6b38be229383927c10e010b15dcee1e9082324092ed67d0ee2a
BLAKE2b-256 checksum
How to use checksums
70c54a1c54b7ac8c140fe4cf168a0c2e003cf6d39a635881d2f23f0fc3fde2bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for vgen-apimatic 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.

Release history Release notifications | RSS feed

This release

0.0.1 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