Skip to content
UGC.runUGC.rundocs

API reference

Operations

Discover the full API catalog and request schemas.

Machine-readable reference

The authenticated catalog is filtered by your action permissions. Individual records and dynamic field permissions are checked at execution. Unknown input fields are rejected rather than silently ignored.

bash
curl "https://www.ugc.run/api/v1/projects/$UGC_PROJECT_ID/operations" \
  -H "Authorization: Bearer $UGC_API_KEY"

curl "https://www.ugc.run/api/v1/projects/$UGC_PROJECT_ID/operations/creators.update" \
  -H "Authorization: Bearer $UGC_API_KEY"

Available areas

AreaOperations
Creators & accountsFilter records; create, edit, archive, delete; assignments and rate history
PostsFilter posts and lifetime metrics; change payout eligibility
PaymentsRead ledgers; generate periods; update amount, notes and paid status; bonuses/deductions
NotificationsHistory; individual and broadcast sends; reminder configuration
Charts & queriesDashboard calculations; grouped, filtered record aggregates
Crosspost & RefreshRoutes and destination limits; current and historical refresh jobs
TeamMembers, permissions, invitations, creator memberships and approvals
SettingsTime zone, content rules, support contact, provider configurations
OnboardingRead/update checklists and request signed media uploads
BillingCurrent plan and usage; plan requests; Stripe checkout and portal URLs
ProjectRename; owner-only deletion with exact project-name confirmation
TutorialsPublished video library
Jobs & exportsJob progress and filtered CSV/JSON downloads