Errors

When a request fails, the API returns a non-2xx HTTP status code with a JSON body matching the ApiError schema:

1
{
2
  "message": "API key is invalid or has been revoked.",
3
  "code": "invalid_api_key"
4
}

HTTP status codes

Error codes

More codes will be added over time. Always use the HTTP status code as the primary indicator, and treat code as supplemental information for programmatic branching.

Handling errors in SDKs

Both SDKs throw a typed error that includes the HTTP status and the ApiError body:

1
import { VideoGenClient, VideoGenError } from "@videogen/sdk";
2
3
try {
4
  await client.tools.generateImage({ prompt: "" });
5
} catch (err) {
6
  if (err instanceof VideoGenError) {
7
    console.error(err.statusCode); // 400
8
    console.error(err.body.message); // "prompt is required"
9
    console.error(err.body.code); // "invalid_parameters"
10
  }
11
}