Getting started with the Node SDK

Every VEED model works the same way: you submit a job, the API accepts it immediately, and you poll until it is done. This guide walks that loop end to end in Node, using Fabric 1.0 as the example — swap the client method and the inputs and the shape is identical for every other model.

Install

npm install @veedstudio/sdk

The client reads VEED_API_KEY from the environment, so export the workspace key you created in the dashboard:

export VEED_API_KEY="vp_..."

The whole loop

import { Veed } from "@veedstudio/sdk";

const client = new Veed(); // reads VEED_API_KEY

const job = await client.fabric.generate({
  audio_url: "https://static-assets.veed.io/api-examples/fabric-input.mp3",
  image_url: "https://static-assets.veed.io/api-examples/fabric-input.png",
  resolution: "720p",
});
console.log(job.result);

That is the entire integration. generate() submits the job and polls for you, honouring the interval the API advertises (10 seconds for this model), so you do not write a retry loop by hand.

What this model takes

Both URLs must be publicly reachable over http(s) — the renderer fetches them itself, so a signed URL is fine but a localhost address is not.

resolution accepts 720p, 480p. It is required, and the reference and playground both show 720p as the example, which is the resolution most callers want.

Submitting and polling by hand

If you would rather drive the two calls yourself — a queue worker that persists the job id, say — they are just the two endpoints the SDK wraps:

import { Veed } from "@veedstudio/sdk";

const client = new Veed(); // reads VEED_API_KEY

const job = await client.fabric.submit({
  audio_url: "https://static-assets.veed.io/api-examples/fabric-input.mp3",
  image_url: "https://static-assets.veed.io/api-examples/fabric-input.png",
  resolution: "720p",
});
console.log(job.status);

The submit call answers 202 with a job_id and a status. Poll the second endpoint with that id until status leaves PROCESSING:

import { Veed } from "@veedstudio/sdk";

const client = new Veed(); // reads VEED_API_KEY

const job = await client.fabric.get("<job_id>");
console.log(job.status);

The job envelope you get back is the same either way:

status moves through PROCESSING, COMPLETED, FAILED, CANCELLED. Only COMPLETED carries a result; only FAILED carries an error.

When a job fails

An accepted job can still fail while rendering, and the failure is reported on the poll response rather than as an HTTP error. The codes this model can return are input_validation, content_moderation, invalid_file, audio_too_long, transload_failed, generation_failed, timeout.

Treat anything other than COMPLETED and PROCESSING as terminal: a CANCELLED or FAILED job will not change state again, and polling it further only burns rate limit.

What it costs

It costs $0.08–$0.15 per second of the generated video, billed on the output rather than on the source image. The pricing page breaks that down per resolution.

Next

• Try the same inputs in the playground before you write any code
• Every other model follows this submit-and-poll shape — the reference pages list the inputs each one takes