AnimationAPI Node.js Library

A Node.js wrapper for the AnimationAPI API - Animated Content video generation service.

Documentation

Find the full API documentation here

Requirements

Node 18 or higher.

Installation

Install the package with:

npm install animationapi
# or
pnpm add animationapi
# or
yarn add animationapi
# or
bun animationapi

Usage

Create videos

import { Configuration, VideosApi } from "animationapi";

try {
  const aa = new VideosApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  //create the request body
  const body = {
    template_id: "ffffa434-0000-0000-b290-0b30ad82d5d3",
    format: "mp4",
    fps: 24,
    // add page, layer modifications
  };

  const result = await aa.createVideos(body);

  //do something with the result
} catch (e) {
  console.log(e);
}

Get video status

import { Configuration, VideosApi } from "animationapi";

try {
  const aa = new VideosApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // check video status using request id
  const result = await aa.getVideoStatus(
    "838f42ca-8072-4e0c-913b-35f867aa2e43"
  );

  //do something with the result
} catch (e) {
  console.log(e);
}

List all videos

import { Configuration, VideosApi } from "animationapi";

try {
  const aa = new VideosApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // List generated videos
  const result = await aa.listAllVideos();

  //do something with the result
} catch (e) {
  console.log(e);
}

List all templates

import { Configuration, TemplatesApi } from "animationapi";

try {
  const aa = new TemplatesApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // list all templates in your org
  const result = await aa.listAllTemplates();

  //do something with the result
} catch (e) {
  console.log(e);
}

Create webhook

import { Configuration, WebhooksApi } from "animationapi";

try {
  const aa = new WebhooksApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  //create the request body
  const body = {
    url: "https://example.com/webhook", //the webhook endpoint to recieve notifications
    events: ["video.started", "video.failed"],
    enabled: true,
  };

  const result = await aa.createWebhook(body);

  //do something with the result
} catch (e) {
  console.log(e);
}

Get a webhook

import { Configuration, WebhooksApi } from "animationapi";

try {
  const aa = new WebhooksApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // get detail of webhook using webhook id
  const result = await aa.getWebhook("4c710de5-3111-41a9-acee-66fb0669de00");

  //do something with the result
} catch (e) {
  console.log(e);
}

Update webhook

import { Configuration, WebhooksApi } from "animationapi";

try {
  const aa = new WebhooksApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // create the request body
  const body = {
    events: ["video.started", "video.finished", "video.failed"],
  };

  // specify the webhook id & the modifications
  const result = await aa.updateWebhook(
    "4c710de5-3111-41a9-acee-66fb0669de00",
    body
  );

  //do something with the result
} catch (e) {
  console.log(e);
}

Delete webhook

import { Configuration, WebhooksApi } from "animationapi";

try {
  const aa = new WebhooksApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // specify the webhook id
  const result = await aa.deleteWebhook("4c710de5-3111-41a9-acee-66fb0669de00");
  
  //do something with the result
} catch (e) {
  console.log(e);
}

List all webhooks

import { Configuration, WebhooksApi } from "animationapi";

try {
  const aa = new WebhooksApi(
    new Configuration({
      accessToken: process.env.ANIMATIONAPI_API_KEY ?? "",
      baseOptions: {
        headers: {
          "Content-Type": "application/json",
        },
      },
    })
  );

  // list all webhooks
  const result = await aa.listAllWebhooks();

  //do something with the result
} catch (e) {
  console.log(e);
}