ugcinc

Official TypeScript/JavaScript client for the UGC Inc API.

Use this README as a quick reference. For full API details, examples, onboarding, and product information, go to:

• Docs: https://docs.ugc.inc
• Website: https://ugc.inc

Installation

npm install ugcinc

Quick Start

import { UGCClient } from "ugcinc";

const client = new UGCClient({
  apiKey: process.env.UGC_API_KEY!,
  // optional: when using admin key, scope requests to a specific org
  orgId: "org_123",
});

const res = await client.accounts.getAccounts({ status: "setup" });

if (res.ok) {
  console.log(res.data.length);
}

Authentication

• apiKey is required.
• Standard API keys operate on their own organization.
• Admin keys can be scoped with orgId.

Overview

UGCClient groups the API into a few top-level namespaces:

• client.accounts: list, create, update, troubleshoot, and manage account lifecycle
• client.posts: create video/slideshow posts, update them, retry failures, and preview schedule conflicts
• client.media: upload media, create media records, manage tags/names, and work with social audio
• client.stats: fetch account/post analytics, daily aggregates, top performers, and refresh stats
• client.org: manage organizations, API keys, and integration keys
• client.billing: inspect subscription state and handle account deactivation, replacements, and refunds
• client.automations: create, run, publish, export, and monitor automation workflows
• client.comments and client.tasks: manage comment jobs and account tasks

The package also exports the API request/response types plus automation/render utilities used by the product.

Common Pattern

All client methods return the same response envelope:

type ApiResponse<T> =
  | { ok: true; code: 200; message: string; data: T }
  | { ok: false; code: number; message: string };

Example:

const posts = await client.posts.getPosts({ accountIds: ["acc_123"] });

if (posts.ok) {
  console.log(posts.data.length);
} else {
  console.error(posts.code, posts.message);
}

Useful Exports

• UGCClient for API access
• Request/response types for all public client methods
• Automation graph utilities and node definitions
• Render helpers and render job types

Full Reference

For the full endpoint reference, all method signatures, data structures, and workflow examples:

• Docs: https://docs.ugc.inc
• Website: https://ugc.inc

License

MIT