APIMatic Portal Artifacts API SDK

The APIMatic Portal Artifacts API SDK for Python provides access to the APIMatic Portal Artifacts API REST APIs from Python applications.

Generate the artifacts an APIMatic API Portal needs (SDKs, code samples, getting started guides and, optionally, a context plugin) from a Portal Build Input, asynchronously.

The generation flow is:

1. Upload your build directory as a zip file using Generate Portal Artifacts Async. You get back an id and links to check the status and download the artifacts.
2. Poll Get Portal Artifacts Generation Status until generation completes, or pass the X-APIMatic-CallbackUrl header in step 1 to be notified instead.
3. Download the generated artifacts using Download Generated Portal Artifacts.

Installation

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

pip install automated-package-publishing-sdk

uv add automated-package-publishing-sdk

poetry add automated-package-publishing-sdk

To install from the SDK source instead, give the tool a path containing a slash — a bare folder name is looked up on PyPI, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

Quick Start

Synchronous client

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

from api_matic_portal_artifacts_api import ApiMaticPortalArtifactsApiClient

client = ApiMaticPortalArtifactsApiClient(authorization="YOUR_API_KEY", environment="production")

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

client.close()

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

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

AsyncApiMaticPortalArtifactsApiClient mirrors ApiMaticPortalArtifactsApiClient 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 api_matic_portal_artifacts_api import AsyncApiMaticPortalArtifactsApiClient


async def main() -> None:
    client = AsyncApiMaticPortalArtifactsApiClient(authorization="YOUR_API_KEY", environment="production")
    # TODO: call endpoints here, awaiting each -- see api-reference.md
    await client.aclose()


run(main())

Alternatively, scope it -- async with AsyncApiMaticPortalArtifactsApiClient(...) 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:

Both API references carry every one of the 8 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 ApiMaticPortalArtifactsApiClient() as client: / async with AsyncApiMaticPortalArtifactsApiClient() 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.

For further assistance, please contact support at contactus@apimatic.io.