ugcfans_ad_to_film

Makes an editable film from a finished video ad, so its captions and end card can be changed, and returns the film and its first revision. The ad must be finished, must not already be a film, must be a video and at most 96 MiB. Free of credits.

Argument	Type	Description
ad*	string	The ad id, from a finished ugcfans_make_ad job.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "ad"
  ],
  "properties": {
    "ad": {
      "type": "string",
      "maxLength": 128,
      "description": "The ad id, from a finished ugcfans_make_ad job."
    }
  },
  "additionalProperties": false
}

ugcfans_cancel_job

Stops a job that has not yet reached a provider; a cancelled job is not charged. A job that is already with a provider cannot be stopped and the call says so. Free.

destructive

Argument	Type	Description
job*	string	The job id a tool returned, job_...

Input schema (JSON)

{
  "type": "object",
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "type": "string",
      "maxLength": 128,
      "description": "The job id a tool returned, job_..."
    }
  },
  "additionalProperties": false
}

ugcfans_capture_website

Opens a public web page in a sandboxed browser, records its text, pictures and layout, and returns a job whose result is a capture id. A capture is the raw material of ugcfans_make_launch_film and ugcfans_make_site_sting. Free of credits. Calling it confirms the person has the right to reuse the page's content in their own films. Only http and https pages on ports 80 and 443 can be captured.

Argument	Type	Description
url*	string	The address of the page, starting with https:// or http://.
viewport	string	desktop captures a 1280 by 900 window (the default); phone captures 390 by 844 at twice the density.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "The address of the page, starting with https:// or http://."
    },
    "viewport": {
      "enum": [
        "desktop",
        "phone"
      ],
      "type": "string",
      "description": "desktop captures a 1280 by 900 window (the default); phone captures 390 by 844 at twice the density."
    }
  },
  "additionalProperties": false
}

ugcfans_export_film

Renders one revision of a film to an MP4 with a content credential, and returns a job; when it is done the result carries a link to the file. Free of credits. A film with an unresolved rendering requirement cannot be exported.

Argument	Type	Description
film*	string	The film id.
revision*	string	The revision to render.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "film",
    "revision"
  ],
  "properties": {
    "film": {
      "type": "string",
      "maxLength": 128,
      "description": "The film id."
    },
    "revision": {
      "type": "string",
      "maxLength": 128,
      "description": "The revision to render."
    }
  },
  "additionalProperties": false
}

ugcfans_find_business

Finds the website of a business from its name, or reads an address. A name is searched on the web and each candidate site is read and ranked; when two sites carry the name about equally, ask is true and the person should say which is theirs. Returns each candidate's address, name, a sentence about it and the evidence for it. Free of credits.

read-only

Argument	Type	Description
query*	string	The business's name, or its website address.
country	string	The person's country as two letters, such as IN. It decides between sites that carry the same name.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 200,
      "description": "The business's name, or its website address."
    },
    "country": {
      "type": "string",
      "maxLength": 2,
      "description": "The person's country as two letters, such as IN. It decides between sites that carry the same name."
    }
  },
  "additionalProperties": false
}

ugcfans_finish_clip

Runs up to 6 finishing operations in order on a clip of the library, each on the file the one before made: trim, reformat to another frame, burn in captions, overlay a brand logo, close with an end card, or mix in music. Returns the last job, whose result links the finished file. A call that runs past 4 minutes returns the job it is on and the operations still to run. Free of credits. The clip must already be in the library: upload footage at https://ugc.fans/library, then find its address with ugcfans_list_files. mix confirms the person may use the music file.

Argument	Type	Description
source*	string	The clip's address in the library, out/...
operations*	array	The operations, in order.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source",
    "operations"
  ],
  "properties": {
    "source": {
      "type": "string",
      "maxLength": 512,
      "description": "The clip's address in the library, out/..."
    },
    "operations": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "op"
        ],
        "properties": {
          "op": {
            "enum": [
              "trim",
              "reformat",
              "captions",
              "overlay",
              "end_card",
              "mix"
            ],
            "type": "string",
            "description": "What to do."
          },
          "end": {
            "type": "number",
            "minimum": 0,
            "description": "trim: where to stop, in seconds."
          },
          "cues": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "start",
                "end",
                "text"
              ],
              "properties": {
                "end": {
                  "type": "number",
                  "minimum": 0,
                  "description": "Seconds."
                },
                "text": {
                  "type": "string",
                  "maxLength": 400,
                  "description": "The line."
                },
                "start": {
                  "type": "number",
                  "minimum": 0,
                  "description": "Seconds."
                }
              },
              "additionalProperties": false
            },
            "maxItems": 2000,
            "description": "captions: the lines to show, each with start and end seconds and its text."
          },
          "mode": {
            "enum": [
              "crop",
              "pad",
              "follow"
            ],
            "type": "string",
            "description": "reformat: crop the picture, pad it, or follow the subject (default crop)."
          },
          "brand": {
            "type": "string",
            "maxLength": 128,
            "description": "overlay and end_card: the id of a saved brand; overlay puts its logo in the top-right corner, and end_card uses its colours and logo."
          },
          "music": {
            "type": "string",
            "maxLength": 512,
            "description": "mix: the address of the music file, out/..., which the person has the right to use."
          },
          "start": {
            "type": "number",
            "minimum": 0,
            "description": "trim: where to start, in seconds (default 0)."
          },
          "subline": {
            "type": "string",
            "maxLength": 200,
            "description": "end_card: a second line."
          },
          "headline": {
            "type": "string",
            "maxLength": 200,
            "description": "end_card: the closing headline."
          },
          "transcript": {
            "type": "string",
            "maxLength": 128,
            "description": "captions: the id of a transcript from ugcfans_transcribe."
          },
          "aspect_ratio": {
            "enum": [
              "9:16",
              "1:1",
              "16:9",
              "4:5"
            ],
            "type": "string",
            "description": "reformat: the new frame."
          }
        },
        "additionalProperties": false
      },
      "maxItems": 6,
      "minItems": 1,
      "description": "The operations, in order."
    }
  },
  "additionalProperties": false
}

ugcfans_get_account

Shows the signed-in account's credits left, credits granted and spent this period, when they expire, its plan and whether the account is admitted to UGCFans. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

ugcfans_get_business

Reads a business that was read: how far the reading is, its profile, and its facts with where each came from and whether it stands or waits for a yes. Optionally searches the pages for words. Free.

read-only

Argument	Type	Description
search	string	Words to look for on the business's pages; answers the pages that hold them with a passage.
business*	string	The business id from the finished ugcfans_read_business job.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "business"
  ],
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 200,
      "description": "Words to look for on the business's pages; answers the pages that hold them with a passage."
    },
    "business": {
      "type": "string",
      "maxLength": 128,
      "description": "The business id from the finished ugcfans_read_business job."
    }
  },
  "additionalProperties": false
}

ugcfans_get_capture

Reads a finished capture: the address it ended on, the parts of the page that can go into a film (node_id, role and the first words), and whether a launch film can be made from it. Free.

read-only

Argument	Type	Description
capture*	string	The capture id from the finished ugcfans_capture_website job.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "capture"
  ],
  "properties": {
    "capture": {
      "type": "string",
      "maxLength": 128,
      "description": "The capture id from the finished ugcfans_capture_website job."
    }
  },
  "additionalProperties": false
}

ugcfans_get_job

Reads where a job stands: working, done with its files as links, failed with the reason, or cancelled. Free. Works for any job the account started.

read-only

Argument	Type	Description
job*	string	The job id a tool returned, job_...

Input schema (JSON)

{
  "type": "object",
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "type": "string",
      "maxLength": 128,
      "description": "The job id a tool returned, job_..."
    }
  },
  "additionalProperties": false
}

ugcfans_list_files

Lists files in the account's library, newest first: the path of each (out/...), its size and when it changed. Pictures, video, audio and fonts only. Free. Footage is added at https://ugc.fans/library; the path is what the clip and transcript tools take as source.

read-only

Argument	Type	Description
limit	integer	How many files to list, newest first.
prefix	string	Only paths that start with this, such as out/api/images. The default is the whole library, out.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "How many files to list, newest first."
    },
    "prefix": {
      "type": "string",
      "maxLength": 512,
      "description": "Only paths that start with this, such as out/api/images. The default is the whole library, out."
    }
  },
  "additionalProperties": false
}

ugcfans_make_launch_film

Makes a 12-second launch film of the page's headline, button and picture from a finished capture, in the chosen frame, and returns a job. The result is an editable film; ugcfans_export_film renders it to MP4. Free of credits. A launch film has no text layers: its words are pictures of the page.

Argument	Type	Description
aspect*	string	The frame: 16:9 landscape, 9:16 vertical, 1:1 square.
capture*	string	The capture id.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "capture",
    "aspect"
  ],
  "properties": {
    "aspect": {
      "enum": [
        "16:9",
        "9:16",
        "1:1"
      ],
      "type": "string",
      "description": "The frame: 16:9 landscape, 9:16 vertical, 1:1 square."
    },
    "capture": {
      "type": "string",
      "maxLength": 128,
      "description": "The capture id."
    }
  },
  "additionalProperties": false
}

ugcfans_make_site_sting

Makes a 12-second, 8-scene film from the page parts you choose (node_ids from ugcfans_get_capture), in the chosen frame. Unlike a launch film its page text stays as editable text, so ugcfans_set_film_words can change it. Free of credits. Returns the film and its first revision at once.

Argument	Type	Description
aspect*	string	The frame: 16:9 landscape, 9:16 vertical, 1:1 square.
capture*	string	The capture id.
node_ids*	array	The node_id of each part to include, from ugcfans_get_capture.
key_phrase	string	A phrase of the chosen text to feature. It must appear in the chosen parts.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "capture",
    "node_ids",
    "aspect"
  ],
  "properties": {
    "aspect": {
      "enum": [
        "16:9",
        "9:16",
        "1:1"
      ],
      "type": "string",
      "description": "The frame: 16:9 landscape, 9:16 vertical, 1:1 square."
    },
    "capture": {
      "type": "string",
      "maxLength": 128,
      "description": "The capture id."
    },
    "node_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200,
        "description": "A node_id."
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "The node_id of each part to include, from ugcfans_get_capture."
    },
    "key_phrase": {
      "type": "string",
      "maxLength": 200,
      "description": "A phrase of the chosen text to feature. It must appear in the chosen parts."
    }
  },
  "additionalProperties": false
}

ugcfans_read_business

Reads a business's website page by page (up to 25 pages) and writes its profile (business.md, every line with the page it came from) and its canonical facts (name, logo, colours, tagline, products with prices, claims; each with its page, and held for a yes where pages disagree or a claim has no proof). Returns a job whose result is a business id; read it with ugcfans_get_business. Free of credits.

Argument	Type	Description
url*	string	The business's website address.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "The business's website address."
    }
  },
  "additionalProperties": false
}

ugcfans_save_business

Saves the facts that stand (taken from the site, or confirmed by the person) as a brand kit and products with their pictures, and keeps business.md and facts.json in the library for later makers. Facts that wait for a yes are not saved. Free.

Argument	Type	Description
business*	string	The business id from the finished ugcfans_read_business job.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "business"
  ],
  "properties": {
    "business": {
      "type": "string",
      "maxLength": 128,
      "description": "The business id from the finished ugcfans_read_business job."
    }
  },
  "additionalProperties": false
}

ugcfans_search_templates

Lists the ad templates, ad features and creation modes UGCFans offers, each with its slug, name and a sentence on what it makes. Free, and needs no sign-in. A template slug goes into ugcfans_make_ad as template; a feature slug as feature.

read-only

Argument	Type	Description
query	string	Words to look for in names and descriptions, such as "testimonial" or "product video". Leave out to list everything.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 200,
      "description": "Words to look for in names and descriptions, such as \"testimonial\" or \"product video\". Leave out to list everything."
    }
  },
  "additionalProperties": false
}

ugcfans_set_film_words

Changes text in a film: every text layer whose words contain find gets replace, and the result is saved as a new revision; the earlier revision stays as it was. Films made by ugcfans_make_launch_film have no text layers, so nothing changes in them. Free of credits.

Argument	Type	Description
film*	string	The film id.
revision*	string	The revision to edit.
replacements*	array	Pairs of words to find and what to put in their place, applied in order.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "film",
    "revision",
    "replacements"
  ],
  "properties": {
    "film": {
      "type": "string",
      "maxLength": 128,
      "description": "The film id."
    },
    "revision": {
      "type": "string",
      "maxLength": 128,
      "description": "The revision to edit."
    },
    "replacements": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "find",
          "replace"
        ],
        "properties": {
          "find": {
            "type": "string",
            "maxLength": 400,
            "minLength": 1,
            "description": "The words to find."
          },
          "replace": {
            "type": "string",
            "maxLength": 400,
            "description": "The words to put in their place."
          }
        },
        "additionalProperties": false
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "Pairs of words to find and what to put in their place, applied in order."
    }
  },
  "additionalProperties": false
}

ugcfans_share_file

Makes a link that opens one file of the library for anyone who holds it, without signing in. A link lasts 6 hours; a showcase page, which carries the Made with UGCFans badge, lasts 30 days. Free. Anyone with the link can see the file until it expires.

Argument	Type	Description
kind	string	link opens the file itself (default); showcase is a page that shows it.
path*	string	The file's address in the library, out/...

Input schema (JSON)

{
  "type": "object",
  "required": [
    "path"
  ],
  "properties": {
    "kind": {
      "enum": [
        "link",
        "showcase"
      ],
      "type": "string",
      "description": "link opens the file itself (default); showcase is a page that shows it."
    },
    "path": {
      "type": "string",
      "maxLength": 512,
      "description": "The file's address in the library, out/..."
    }
  },
  "additionalProperties": false
}

ugcfans_transcribe

Writes out the words of an audio or video file in the library, up to 10 minutes long, with the built-in speech model, and returns a job; when it is done the result has the transcript id, its text, the language and the length. The transcript id feeds the captions operation of ugcfans_finish_clip. Free of credits. Upload footage at https://ugc.fans/library first, then find its address with ugcfans_list_files.

Argument	Type	Description
source*	string	The file's address in the library, out/...

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source"
  ],
  "properties": {
    "source": {
      "type": "string",
      "maxLength": 512,
      "description": "The file's address in the library, out/..."
    }
  },
  "additionalProperties": false
}

ugcfans_wait_job

Waits up to 45 seconds for a job to finish and reports where it stands, as ugcfans_get_job does. It returns as soon as the job ends. Free.

read-only

Argument	Type	Description
job*	string	The job id a tool returned, job_...
seconds	integer	How long to wait at most, up to 45 (default 45).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "type": "string",
      "maxLength": 128,
      "description": "The job id a tool returned, job_..."
    },
    "seconds": {
      "type": "integer",
      "maximum": 45,
      "minimum": 0,
      "description": "How long to wait at most, up to 45 (default 45)."
    }
  },
  "additionalProperties": false
}

UGC Fans Studio

Try it

ugcfans_ad_to_film

UGC Fans Studio

Try it

ugcfans_ad_to_film

Tools (20)