Choose an SDK or automation integration
All integrations reach the Zvid API, but installation, available actions and approval behavior differ. For the exact current request contract, use the API reference and free validation.
Select the interface
| Interface | Best starting point | Authentication |
|---|---|---|
| Direct REST | Any server language or an HTTP automation step | X-Api-Key header from API keys |
| JavaScript / TypeScript | A Node.js application using the published @zvid/sdk | API key kept on your server |
| Hosted MCP | ChatGPT, Codex and other MCP clients | Account OAuth; API-key header for clients that support it |
| n8n | Visual automation and MCP-powered agents | Zvid credentials for action nodes; MCP OAuth2 API or Header Auth for MCP |
| Make | The Zvid custom app and available modules | Zvid connection/API key |
| Python, LangChain, Vercel AI tools | Source integrations under development | API key; verify local build and dependency instructions |
JavaScript and TypeScript
Install the published package:
npm install @zvid/sdk
The package name is @zvid/sdk. Keep ZVID_API_KEY in your server environment. Review the SDK's retry settings before submitting paid jobs; automatic retries on an uncertain submission can create duplicate work. Use the safe standalone REST example if you need validation followed by exactly one submission.
Package availability was checked on 22 September 2026: @zvid/sdk version 0.2.0, @zvid/mcp version 0.1.0, and @zvid/n8n-nodes-zvid version 0.1.8 were published. These are verification snapshots, not a promise that they remain the latest versions. Check release notes before upgrading.
ChatGPT and other assistants
Use the assistant setup guide for the hosted endpoint https://mcp.zvid.io/mcp, profiles, account connections, credit ceilings and the draft/quote/approval flow. Reading the documentation alone does not grant an assistant access to your Zvid account.
n8n
For direct Zvid action and trigger nodes, install @zvid/n8n-nodes-zvid from Settings → Community nodes before configuring Zvid credentials. A workspace owner or administrator may need to install it. Use the supported Zvid node operation when one is available.
For a chat agent, use n8n's built-in MCP Client Tool with https://mcp.zvid.io/mcp. Use an MCP OAuth2 API credential for account sign-in or Header Auth with x-api-key. The removed zvidAgentTools node is not an installation option. MCP profile and maxRenderCredits settings are URL query parameters; see assistant profiles.
Rendering in an automation spends credits. Validate input, preserve returned job IDs, and gate any watch/download step on completed media. An MCP agent's approval workflow and a direct node's render action have different controls.
Make and source previews
The Make integration is a custom app; use its supplied installation and connection instructions rather than assuming every workspace can find it in a public marketplace. Availability and module sets should be verified in your workspace.
The Python zvid, langchain-zvid and zvid-ai-tools packages were not available from their public registries when checked on 22 September 2026. Their source code is not evidence that a registry installation will work. Use the corresponding source README for local development, or call REST from your language. Public installation commands should be added only after a verified release.
Production checklist
Validate and estimate before rendering, handle both numeric and object job progress, normalize the final output URL, and use signed webhooks or bounded polling. Follow error and retry guidance and verify which operations your installed integration actually exposes.