What's New in v4
Every major change in APIMatic v4: Context Plugins, new SDKs, and a new developer portal.
APIMatic v4 gives developers and their AI coding agents everything they need to integrate with your API, generated from a single API definition. It runs on a new code generator, Codegen v4, and APIMatic CLI v2 (currently in beta), and introduces:
- Context Plugins that give AI coding agents your API reference, SDK code, and integration patterns. See Context Plugins Overview.
- New SDKs generated by Codegen v4. See SDK Generation Overview.
- A new developer portal for developers and AI tools, built from your API definition and Markdown pages. See Portal Generation Overview.
Context Plugins
Context Plugins are now built by Codegen v4 from your published SDKs, so an agent gets the same API context in every run instead of guessing from training data or web searches.
- Planning before code. The agent drafts an integration plan from your SDK reference and integration docs before it writes any code.
- Context from your latest SDK. The plugin points agents at your published SDK repositories, so they don't fall behind your releases. See Publish SDKs.
- Correct API behavior. Responses, authentication, idempotency keys, and pagination are handled the way your SDK implements them.
- Complete error coverage. Integrations handle every typed SDK error.
- Production-readiness checks. Each integration comes with tests and a readiness checklist.
- Skills for each SDK language. Client setup, authentication, calling endpoints, handling errors, configuration, and testing. See What an APIMatic Context Plugin contains.
- Popular coding agents. Claude Code, Cursor, VS Code, and Codex.
Seven models, one result: with Context Plugins, every model scores 96 or higher out of 100 for production readiness, from GLM 5.3 Flash to Claude Opus 4.8. On average, readiness improved from 74 to 97 with Context Plugins (APIMatic Context Plugins benchmark).
Production-Grade SDKs
Codegen v4 is a rebuilt code generator. Its SDKs are designed for AI coding agents as well as developers, with authentication, failures, and errors handled inside the SDK. For what each language supports, see Languages & Features.
- Deeper OpenAPI coverage. Unions (
oneOf,anyOf,allOf), open enums, and required, optional, and nullable fields become real types. See OpenAPI support. - Typed errors per endpoint. Errors are typed from the error schemas in your API definition.
- One request pipeline. Authentication, retries, logging, errors, and cancellation run through a single pipeline for every call.
- Built-in resilience. Retries with backoff, a capped
Retry-After, and a fresh timeout for each attempt. See SDK capabilities. - Built-in authentication. API key, Basic, Bearer, and OAuth 2.0.
- Pagination and streaming. Pagination helpers and Server-Sent Events. Support varies by language; see SDK capabilities.
- AI context in every SDK. A README, doc comments, API reference docs, an SDK map, and skills. See Documentation and developer experience.
- Publishing. Package registries and GitHub with
apimatic sdk publish. See Publish SDKs.
Agent-Ready Developer Portal
The developer portal is now a knowledge base for developers and AI agents. apimatic portal generate builds it as static files from your API definition, your Markdown pages, and apimatic.json. See Portal Generation Overview.
- API reference and playground. A page for every endpoint, with a live playground to call it from the browser. See Live API code playground.
- SDK code for every endpoint. Code samples in cURL and each SDK language, using the SDK's own client and methods. See Code samples.
- SDK pages. An SDKs page, plus a getting started page for each SDK. See SDKs.
- Agent-ready docs.
llms.txt,llms-full.txt, and a Markdown version of every page. See The llms.txt Files and Markdown for Every Page. - Page actions for AI tools. Copy a page as Markdown or open it in ChatGPT, Claude, Cursor, or Scira AI. See Page actions.
- Indexable pages. Prerendered HTML, a sitemap, and canonical links based on your site address. See
portal.site. - Docs as code. Configuration in
apimatic.jsonandnav.json, kept in Git next to your content. See The apimatic.json Reference and The nav.json Reference. - Branding and hosting. Your brand in light and dark mode, on any static host, on your own domain or under a path. See Host Your Portal.
APIMatic CLI and Skills
- APIMatic CLI v2, currently in beta, installed with
npm i -g @apimatic/cli@beta. See Install the APIMatic CLI. - Commands for portals, API definitions, SDKs, Context Plugins, publishing, and sign-in. See CLI Reference.
apimatic quickstartto create a portal project. See Quickstart.- Two APIMatic Skills,
apimatic-portalandapimatic-sdk, that let a coding agent run the CLI for you. See Skills Overview.
Migrate to v4
- Projects built with CLI v1 use
APIMATIC-BUILD.jsonandtoc.yml. In v4, these areapimatic.jsonandnav.json. - The
apimatic-portalskill upgrades a CLI v1 portal project to the new files. See APIMatic Portal Skill. - Both skills offer to upgrade an installed CLI v1 to the CLI v2 beta.
- Projects that stay on CLI v1 use the skills on the repository's
v1branch. See Skills for older projects.