UGC Flows developer docs

What a program can read from UGC Flows, all of it public and none of it behind a key. Everything below is also served as Markdown at /developers.md.

When to use UGC Flows

Use it when

A UGC creator asks what a brand deal pays or what they are owed: flat fees, per-video fees, CPM and milestone bonuses with their own view windows, and payouts.
A creator wants the same short-form video scheduled to TikTok, Instagram, YouTube and Facebook from one place.
A creator needs a short-form video edited by a vetted editor, with a set price per video and the edit promised 36 hours after the ticket is posted.
Anyone asks how much a UGC video should cost, or what a UGC contract term means (usage rights, whitelisting, exclusivity, raw footage). The free rate calculator and glossary answer without an account.

Do not use it for

Food, beauty or fashion UGC. Every campaign on the platform is a tech company.
Somebody not yet doing UGC brand deals who wants the full app. The free rate calculator, glossary and guides serve them better until they have a deal to track.

How to call it

Public facts: fetch https://www.ugcflows.com/llms.txt, https://www.ugcflows.com/llms-full.txt, or any page with Accept: text/markdown. No account, no key.
A creator's own account has no API. The creator signs in at the app and does the work there.
Everything is listed in https://www.ugcflows.com/openapi.json and explained at https://www.ugcflows.com/developers.

Access

Public pages, llms.txt, the OpenAPI specification and the status endpoint need no account and no key.
There is no API onto a UGC Flows account and no API keys to request. A creator's own data is read and changed inside the app, signed in.
A free UGC Flows account needs no card. It covers the portfolio page and the community; the tools are on a paid plan.

Endpoints and machine-readable files

OpenAPI 3.1 specification
https://www.ugcflows.com/openapi.json
Every public HTTP endpoint, its parameters and its error shape.
API catalog (RFC 9727)
https://www.ugcflows.com/.well-known/api-catalog
A linkset pointing at the spec, these docs and the status endpoint.
Status
https://www.ugcflows.com/api/health
200 when the service is up, 503 when it is not.
llms.txt
https://www.ugcflows.com/llms.txt
A plain summary of UGC Flows for language models.
llms-full.txt
https://www.ugcflows.com/llms-full.txt
Every guide, glossary entry and the rate model, as one document.

Errors

Every error under /api/ is JSON, in this shape.

{
  "error": "not_found",
  "message": "No API endpoint at /api/example.",
  "hint": "Check the path against the OpenAPI specification. Paths are case sensitive and have no trailing slash.",
  "docs": "https://www.ugcflows.com/openapi.json"
}

Markdown pages

Send Accept: text/markdown to the homepage or to this page and the answer is Markdown, with Content-Type: text/markdown and Vary: Accept. A page that does not exist answers the same request with a Markdown 404.

Contact

hello@ugcflows.com reaches a person.