# UGC Inc API Documentation

## Docs

- [Create Accounts](https://docs.ugc.inc/api-reference/endpoint/accounts-create.md): Create new account seats and update your subscription billing
- [Delete All Posts](https://docs.ugc.inc/api-reference/endpoint/accounts-delete-posts.md): Delete all posts from one or more accounts
- [Get Accounts](https://docs.ugc.inc/api-reference/endpoint/accounts-get.md): Retrieve accounts with optional filters
- [Niche Switch](https://docs.ugc.inc/api-reference/endpoint/accounts-niche-switch.md): Switch account niche by updating keywords and description, and resetting warmup
- [Get Profile Sync Status](https://docs.ugc.inc/api-reference/endpoint/accounts-profile-sync-status.md): Check if custom provider account profiles are in sync with live social profiles
- [Reset Account Warmup](https://docs.ugc.inc/api-reference/endpoint/accounts-reset-warmup.md): Reset or delete warmup activity for an account
- [Get Account Status](https://docs.ugc.inc/api-reference/endpoint/accounts-status.md): Get account status and pending tasks
- [Troubleshoot Accounts](https://docs.ugc.inc/api-reference/endpoint/accounts-troubleshoot.md): Check the health of active accounts and identify issues
- [Update Account Info](https://docs.ugc.inc/api-reference/endpoint/accounts-update-info.md): Update account metadata for one or more accounts (tag, groups, keywords, profiles, description, warmup version)
- [Update Account Social Profile](https://docs.ugc.inc/api-reference/endpoint/accounts-update-social.md): Update account social profile for one or more accounts (username, avatar, nickname, bio)
- [Create or Update Automation Template](https://docs.ugc.inc/api-reference/endpoint/automations-create.md): Create a new automation template or update an existing one
- [Delete Automation Template](https://docs.ugc.inc/api-reference/endpoint/automations-delete.md): Delete an automation template
- [Delete Automation Run](https://docs.ugc.inc/api-reference/endpoint/automations-delete-run.md): Delete a run and its execution state
- [Export Automation Template](https://docs.ugc.inc/api-reference/endpoint/automations-export.md): Export full template data for debugging and tooling
- [Export Automation Run](https://docs.ugc.inc/api-reference/endpoint/automations-export-run.md): Export full run data including executor and edge state
- [Get Automation Template](https://docs.ugc.inc/api-reference/endpoint/automations-get.md): Retrieve a single automation template
- [List Automation Templates](https://docs.ugc.inc/api-reference/endpoint/automations-list.md): Retrieve all automation templates for the authenticated organization
- [List All Automation Runs](https://docs.ugc.inc/api-reference/endpoint/automations-list-all-runs.md): List automation runs across templates
- [List Template Runs](https://docs.ugc.inc/api-reference/endpoint/automations-list-runs.md): List runs for a specific automation template
- [Get Automation Run Logs](https://docs.ugc.inc/api-reference/endpoint/automations-logs.md): Retrieve run logs ordered by creation time
- [Publish Automation](https://docs.ugc.inc/api-reference/endpoint/automations-publish.md): Enable recurrence scheduling for an automation template
- [Get Recurrence Status](https://docs.ugc.inc/api-reference/endpoint/automations-recurrence-status.md): Get scheduling status for a recurring automation template
- [Run Automation](https://docs.ugc.inc/api-reference/endpoint/automations-run.md): Start one or more runs for an automation template
- [Run Automation Once](https://docs.ugc.inc/api-reference/endpoint/automations-run-once.md): Immediately trigger one manual run for a template
- [Get Automation Run Status](https://docs.ugc.inc/api-reference/endpoint/automations-status.md): Get run state, executors, and execution edges
- [Stop Automation Run](https://docs.ugc.inc/api-reference/endpoint/automations-stop.md): Stop an in-progress run
- [Unpublish Automation](https://docs.ugc.inc/api-reference/endpoint/automations-unpublish.md): Disable recurrence scheduling for an automation template
- [Update Run Review Status](https://docs.ugc.inc/api-reference/endpoint/automations-update-review-status.md): Approve or reject an automation run
- [Validate Workflow](https://docs.ugc.inc/api-reference/endpoint/automations-validate.md): Validate an automation workflow definition without saving it
- [Cancel Subscription](https://docs.ugc.inc/api-reference/endpoint/billing-cancel.md): Cancel your subscription at the end of the current billing period
- [Deactivate Account](https://docs.ugc.inc/api-reference/endpoint/billing-deactivate.md): Deactivate an account slot and remove it from your subscription
- [Get Billing](https://docs.ugc.inc/api-reference/endpoint/billing-get.md): Get billing information including subscription details and linked organizations
- [Billing Portal](https://docs.ugc.inc/api-reference/endpoint/billing-portal.md): Get a Stripe billing portal URL for managing payment methods
- [Request Refund](https://docs.ugc.inc/api-reference/endpoint/billing-request-refund.md): Request a refund for an account
- [Request Replacement](https://docs.ugc.inc/api-reference/endpoint/billing-request-replacement.md): Request a replacement for an account
- [Get Billing Requests](https://docs.ugc.inc/api-reference/endpoint/billing-requests.md): Get all billing requests (replacements and refunds)
- [Create Comment](https://docs.ugc.inc/api-reference/endpoint/comments-create.md): Create a comment on a TikTok post
- [Get Comments](https://docs.ugc.inc/api-reference/endpoint/comments-list.md): Get comments for your organization
- [Create Media from URLs](https://docs.ugc.inc/api-reference/endpoint/media-create.md): Create media records from files already uploaded to blob storage
- [Create Text Media](https://docs.ugc.inc/api-reference/endpoint/media-create-text.md): Create text media entries from raw text content
- [Get Upload Token](https://docs.ugc.inc/api-reference/endpoint/media-create-url.md): Generate a Vercel Blob client token for direct media uploads
- [Delete Media](https://docs.ugc.inc/api-reference/endpoint/media-delete.md): Delete one or more media items
- [Get Media File](https://docs.ugc.inc/api-reference/endpoint/media-file.md): Fetch media content by ID (supports preview/audio paths and HTTP range requests)
- [Filter Media by Usage](https://docs.ugc.inc/api-reference/endpoint/media-filter.md): Filter source IDs into available vs used for a named media use-case
- [Get Media](https://docs.ugc.inc/api-reference/endpoint/media-get.md): Retrieve media files with optional filters
- [Get Social Audio](https://docs.ugc.inc/api-reference/endpoint/media-social-audio-get.md): Retrieve social audio files with optional filters
- [Upload Social Audio](https://docs.ugc.inc/api-reference/endpoint/media-social-audio-upload.md): Import audio from a TikTok or Instagram URL
- [Update Media Name](https://docs.ugc.inc/api-reference/endpoint/media-update-name.md): Update the name of a media item
- [Update Media Tag](https://docs.ugc.inc/api-reference/endpoint/media-update-tag.md): Update tags on one or more media items
- [Get Media Use Entries](https://docs.ugc.inc/api-reference/endpoint/media-use.md): Get media usage records for a specific use-case name
- [Delete API Key](https://docs.ugc.inc/api-reference/endpoint/org-api-keys-delete.md): Delete an API key from your organization
- [Edit API Key](https://docs.ugc.inc/api-reference/endpoint/org-api-keys-edit.md): Update an API key's name
- [List API Keys](https://docs.ugc.inc/api-reference/endpoint/org-api-keys-list.md): Retrieve all API keys for your organization
- [Get Organizations](https://docs.ugc.inc/api-reference/endpoint/org-get.md): List organizations linked to your API key
- [Delete Integration Key](https://docs.ugc.inc/api-reference/endpoint/org-integration-keys-delete.md): Delete an integration key for a provider
- [List Integration Keys](https://docs.ugc.inc/api-reference/endpoint/org-integration-keys-list.md): Retrieve all integration keys for your organization
- [Upsert Integration Key](https://docs.ugc.inc/api-reference/endpoint/org-integration-keys-upsert.md): Create or update an integration key for a provider
- [Update Organization Name](https://docs.ugc.inc/api-reference/endpoint/org-update-name.md): Update your organization's name
- [Create Draft Post](https://docs.ugc.inc/api-reference/endpoint/posts-create-draft.md): Create a draft post without assigning it to an account
- [Create Slideshow Post](https://docs.ugc.inc/api-reference/endpoint/posts-create-slideshow.md): Create a slideshow post from multiple images
- [Create Video Post](https://docs.ugc.inc/api-reference/endpoint/posts-create-video.md): Create a video post
- [Delete Posts](https://docs.ugc.inc/api-reference/endpoint/posts-delete.md): Delete one or more posts
- [Get Posts](https://docs.ugc.inc/api-reference/endpoint/posts-get.md): Retrieve posts with optional filters
- [Preview Schedule](https://docs.ugc.inc/api-reference/endpoint/posts-preview-schedule.md): Preview finalized post times before creating or updating posts
- [Retry Posts](https://docs.ugc.inc/api-reference/endpoint/posts-retry.md): Retry one or more failed posts
- [Get Post Status](https://docs.ugc.inc/api-reference/endpoint/posts-status.md): Get the status of a specific post
- [Update Post](https://docs.ugc.inc/api-reference/endpoint/posts-update.md): Update an existing scheduled or failed post in place
- [Get Account Statistics](https://docs.ugc.inc/api-reference/endpoint/stats-accounts.md): Retrieve account statistics with filters
- [Get Daily Aggregated Statistics](https://docs.ugc.inc/api-reference/endpoint/stats-aggregated-daily.md): Get pre-aggregated daily statistics for dashboard charts
- [Get Daily Post Stats](https://docs.ugc.inc/api-reference/endpoint/stats-aggregated-daily-posts.md): Get per-post daily metric values and changes
- [Get Top Accounts](https://docs.ugc.inc/api-reference/endpoint/stats-aggregated-top-accounts.md): Get the highest-performing accounts by a specific metric
- [Get Top Posts](https://docs.ugc.inc/api-reference/endpoint/stats-aggregated-top-posts.md): Get the highest-performing posts by a specific metric
- [Get Dashboard Daily Statistics](https://docs.ugc.inc/api-reference/endpoint/stats-dashboard-daily.md): Retrieve pre-aggregated daily statistics for dashboard charts
- [Get Daily Account Stats (Granular)](https://docs.ugc.inc/api-reference/endpoint/stats-granular-daily-accounts.md): Get per-account daily metric deltas
- [Get Post Statistics](https://docs.ugc.inc/api-reference/endpoint/stats-posts.md): Retrieve post statistics with filters
- [Refresh Statistics](https://docs.ugc.inc/api-reference/endpoint/stats-refresh.md): Fetch live statistics from TikTok/Instagram API for all accounts in your organization
- [Delete Tasks](https://docs.ugc.inc/api-reference/endpoint/tasks-delete.md): Delete one or more scheduled or failed tasks
- [Get Tasks](https://docs.ugc.inc/api-reference/endpoint/tasks-get.md): Retrieve tasks with optional filters
- [Retry Tasks](https://docs.ugc.inc/api-reference/endpoint/tasks-retry.md): Retry one or more failed tasks
- [Account](https://docs.ugc.inc/data-structures/account.md): Social media account data structure
- [Account Stat](https://docs.ugc.inc/data-structures/account-stat.md): Account statistics data structure
- [API Key](https://docs.ugc.inc/data-structures/api-key.md): API key data structure for authentication
- [Automation](https://docs.ugc.inc/data-structures/automation.md): Core automation template, run, executor, and workflow graph types
- [Billing Request](https://docs.ugc.inc/data-structures/billing-request.md): Billing request data structure for replacements and refunds
- [Comment](https://docs.ugc.inc/data-structures/comment.md): Comment task data returned by the comments API
- [Editor](https://docs.ugc.inc/data-structures/editor.md): Complete timeline editor reference for video and image composition
- [Integration Key](https://docs.ugc.inc/data-structures/integration-key.md): Organization-level third-party provider key metadata
- [Media](https://docs.ugc.inc/data-structures/media.md): Media file data structures for user uploads and social audio
- [Media Use](https://docs.ugc.inc/data-structures/media-use.md): Usage records for source media IDs in named workflows
- [NPM Package Types](https://docs.ugc.inc/data-structures/npm-package-types.md): Complete exported type index for the ugcinc npm package
- [Post](https://docs.ugc.inc/data-structures/post.md): Video or slideshow post data structure
- [Post Stat](https://docs.ugc.inc/data-structures/post-stat.md): Post statistics data structure
- [Task](https://docs.ugc.inc/data-structures/task.md): Account-level task data structure
- [Introduction](https://docs.ugc.inc/index.md): Official API documentation for UGC Inc - Automate TikTok and Instagram content creation
- [Response](https://docs.ugc.inc/response.md): Understanding API responses and error handling

## OpenAPI Specs

- [openapi](https://docs.ugc.inc/api-reference/openapi.json)

## Optional

- [NPM Package](https://www.npmjs.com/package/ugcinc)