TypeScript SDK

IntroCopy Anchor Link

The APIMatic Portal Artifacts API SDK provides access to the APIMatic Portal Artifacts API REST APIs.

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.

InstallationCopy Anchor Link

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { ApiMaticPortalArtifactsApiClient } from "apimatic-portal-artifacts-api";

const client = new ApiMaticPortalArtifactsApiClient({
  authorization: "YOUR_API_KEY",
});

Nothing in ClientOptions is required — new ApiMaticPortalArtifactsApiClient() compiles — and each option left out falls back to its default. This API declares one environment, so there is no environment to select and no host to state at the construction site.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("apimatic-portal-artifacts-api");

const client = new sdk.ApiMaticPortalArtifactsApiClient({
  authorization: "YOUR_API_KEY",
});