Servers Playground How we check Submit a server

UGC Fans

Working · 2.4 s

fans.ugc/makev1.0.0 Domain verified

Make ads, images and video from a URL; every paid generation is quoted in credits first

Marketing & SEO Design & Creative

Source Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.ugc.fans/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

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.

adstring, required

The ad id, from a finished ugcfans_make_ad job.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

UGC Fans MCP server | mcptry

Tools (30)

ugcfans_ad_to_film

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_estimate

Prices a request without making it: the most it can cost in credits, the dollar figures behind it, any warnings, and a quote that is good for about 10 minutes. Free. The body takes the same fields as ugcfans_make_ad, ugcfans_make_image or ugcfans_make_video, without the quote; the make tool takes the quote back and refuses it if any field changed.

read-only

Argument	Type	Description
body*	object	The request: the fields of the make tool for this kind, without quote.
kind*	string	What is being priced.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "kind",
    "body"
  ],
  "properties": {
    "body": {
      "type": "object",
      "description": "The request: the fields of the make tool for this kind, without quote."
    },
    "kind": {
      "enum": [
        "ad",
        "image",
        "video"
      ],
      "type": "string",
      "description": "What is being priced."
    }
  },
  "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_list_models

Lists what UGCFans makes at each quality: stills, clips and talking clips, with the credits each costs per unit (an image, a clip) and whether a plan locks it. Free, and needs no sign-in. Signed out it is the whole price list; signed in it is what is on offer to this account, the model ids ugcfans_estimate and the make tools accept.

read-only

Argument	Type	Description
kind	string	Only models of this kind.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "kind": {
      "enum": [
        "image",
        "video",
        "avatar"
      ],
      "type": "string",
      "description": "Only models of this kind."
    }
  },
  "additionalProperties": false
}

ugcfans_make_ad

Makes a UGC-style ad from a product and a template or feature (testimonial, talking presenter, product video and others) and returns a job; when it is done the result lists the ad's files as links. Spends the account's credits; the cost depends on the feature and its length, so call ugcfans_estimate first and pass its quote. Without a quote this returns the cost and makes nothing. A presenter must be saved, have a portrait and, for a real person, recorded consent at https://ugc.fans/library.

Argument	Type	Description
name	string	A name for the ad.
quote	string	The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing.
voice	string	The voice: the id of a saved voice.
person	string	The presenter: the id of a saved person that has a portrait and, for a real person, recorded consent.
script	string	A script already written, by its id from ugcfans_write_script.
feature*	string	What kind of ad, a slug from ugcfans_search_templates such as testimonial, talking-presenter or product-video.
product	any	What is being sold: a sentence, or an object with its name, description and pictures.

ugcfans_make_image

Makes a picture from a prompt, optionally following reference pictures, and returns a job; when it is done the result links the picture and a small one is shown inline. Spends the account's credits per picture (ugcfans_list_models gives each model's price). Call ugcfans_estimate first and pass its quote; without a quote this returns the cost and makes nothing.

Argument	Type	Description
n	integer	How many pictures (default 1).
model*	string	The model id, from ugcfans_list_models.
quote	string	The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing.
prompt*	string	What to draw, in words.
reference	array	Pictures of the subject or style to follow: addresses of library files, out/...
resolution	string	The resolution, such as 1K, when the model offers it.
aspect_ratio	string	The frame, such as 1:1, 9:16 or 16:9, when the model offers it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "model",
    "prompt"
  ],
  "properties": {
    "n": {
      "type": "integer",
      "maximum": 8,
      "minimum": 1,
      "description": "How many pictures (default 1)."
    },
    "model": {
      "type": "string",
      "maxLength": 200,
      "description": "The model id, from ugcfans_list_models."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing."
    },
    "prompt": {
      "type": "string",
      "maxLength": 4000,
      "description": "What to draw, in words."
    },
    "reference": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 512,
        "description": "An address."
      },
      "maxItems": 16,
      "description": "Pictures of the subject or style to follow: addresses of library files, out/..."
    },
    "resolution": {
      "type": "string",
      "maxLength": 20,
      "description": "The resolution, such as 1K, when the model offers it."
    },
    "aspect_ratio": {
      "type": "string",
      "maxLength": 20,
      "description": "The frame, such as 1:1, 9:16 or 16:9, when the model offers it."
    }
  },
  "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_performance

Puts a saved person on screen and returns a job: talking has them speak a line, motion has them move as a reference clip moves, swap puts them in place of the person in a clip, and product shows them holding a product (a picture). Without a quote, returns the cost and makes nothing. With a held quote, spends the account's credits; a talking clip costs about what its avatar model costs (ugcfans_list_models, kind avatar). The person must be saved with a portrait and, if real, recorded consent at https://ugc.fans/library. motion and swap need rights_confirmed: true, given only after the person confirms they may use the source clip.

Argument	Type	Description
kind*	string	What to make.
note	string	swap: what to change, in words.
text	string	talking: words to speak.
brand	string	product: the id of a saved brand whose kit holds the product pictures.
image	string	talking: which picture of the person to use, out/...
quote	string	The held quote for this exact request, after the person confirms its cost.
voice	string	talking, with script or text: the id of the saved voice to speak in.
person

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_make_speech

Speaks a line or a saved script in a saved voice and returns a job whose result links the audio. Spends a few of the account's credits. Without a quote the call returns the cost and makes nothing; pass the quote with the same request after the person confirms it; a voice that cannot be priced ahead cannot be made here. A cloned voice needs its owner's recorded consent.

Argument	Type	Description
text	string	The words to speak.
quote	string	A quote for exactly this line, when you hold one.
speed	number	How fast, 0.5 to 1.5 (default 1).
voice*	string	The id of a saved voice, voice_...
script	string	Or the id of a saved script to speak.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "voice"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 5000,
      "description": "The words to speak."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "A quote for exactly this line, when you hold one."
    },
    "speed": {
      "type": "number",
      "maximum": 1.5,
      "minimum": 0.5,
      "description": "How fast, 0.5 to 1.5 (default 1)."
    },
    "voice": {
      "type": "string",
      "maxLength": 128,
      "description": "The id of a saved voice, voice_..."
    },
    "script": {
      "type": "string",
      "maxLength": 128,
      "description": "Or the id of a saved script to speak."
    }
  },
  "additionalProperties": false
}

ugcfans_make_video

Makes a video clip from a prompt, optionally beginning on a still, and returns a job; when it is done the result links the clip. Spends the account's credits per clip (ugcfans_list_models gives each model's price). Call ugcfans_estimate first and pass its quote; without a quote this returns the cost and makes nothing.

Argument	Type	Description
model*	string	The model id, from ugcfans_list_models.
quote	string	The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing.
prompt*	string	What happens, in words.
duration	integer	The length in seconds, from the lengths the model offers.
resolution	string	The resolution, such as 720p, when the model offers it.
start_image	string	A picture to begin on: the address of a library file, out/...
aspect_ratio	string	The frame, such as 9:16 or 16:9, when the model offers it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "model",
    "prompt"
  ],
  "properties": {
    "model": {
      "type": "string",
      "maxLength": 200,
      "description": "The model id, from ugcfans_list_models."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing."
    },
    "prompt": {
      "type": "string",
      "maxLength": 4000,
      "description": "What happens, in words."
    },
    "duration": {
      "type": "integer",
      "maximum": 60,
      "minimum": 1,
      "description": "The length in seconds, from the lengths the model offers."
    },
    "resolution": {
      "type": "string",
      "maxLength": 20,
      "description": "The resolution, such as 720p, when the model offers it."
    },
    "start_image": {
      "type": "string",
      "maxLength": 512,
      "description": "A picture to begin on: the address of a library file, out/..."
    },
    "aspect_ratio": {
      "type": "string",
      "maxLength": 20,
      "description": "The frame, such as 9:16 or 16:9, when the model offers it."
    }
  },
  "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_read_reference

Reads a reference video of up to 3 minutes in the library and returns a job whose result is its breakdown: hook, structure, shots, pacing and look, with still frames, and none of its footage, sound or words. Without a quote, returns the cost and makes nothing. A held quote spends a few of the account's credits; rights_confirmed records the person's permission to study the file. Upload the video at https://ugc.fans/library first.

Argument	Type	Description
quote	string	The held quote for this exact request, after the person confirms its cost.
source*	string	The video's address in the library, out/...
rights_confirmed*	boolean	The person confirms they may study this file.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source",
    "rights_confirmed"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The held quote for this exact request, after the person confirms its cost."
    },
    "source": {
      "type": "string",
      "maxLength": 512,
      "description": "The video's address in the library, out/..."
    },
    "rights_confirmed": {
      "type": "boolean",
      "description": "The person confirms they may study this file."
    }
  },
  "additionalProperties": false
}

ugcfans_save_asset

Saves a brand kit, a product, a generated presenter or a stock voice to the library for reuse in ads, and returns its id. Free. Only generated presenters (described in words, not a real person) and stock voices can be saved here: a real person's face or voice needs the consent the person records at https://ugc.fans/library. A new presenter has no picture until its portrait is drawn there.

Argument	Type	Description
url	string	brand and product: their web address.
kind*	string	What to save.
logo	string	brand: the address of its logo, out/...
name*	string	Its name.
tone	string	brand: its voice, such as warm and plain.
brand	string	product: the id of the brand it belongs to.
never	array	brand: words and claims its ads never use.
claims	array	product: claims an ad may make about it.
images	array	brand and product: addresses of product pictures, out/...

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
}

ugcfans_write_script

Writes an ad script from a product or a web page, or, given a saved script, writes alternative opening hooks for it or translates it, and returns a job whose result holds the script. Spends a few of the account's credits only with a held quote. Without one, returns the cost and makes nothing. Give product or page_url to write a new script; give script with hooks (how many) or with translate_to (a language) to work on one.

Argument	Type	Description
angle	string	The angle or hook to take.
brand	string	The id of a saved brand whose voice to follow.
hooks	integer	With script: how many alternative openings to write.
offer	string	The offer or call to action.
quote	string	The held quote for this exact request, after the person confirms its cost.
points	array	Points the script should make.
script	string	The id of a saved script to work on, from an earlier ugcfans_write_script.
product	string	What is being sold, in a sentence or two.
seconds	integer

Input schema (JSON)

{
  "type": "object",
  "required": [
    "feature"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 80,
      "description": "A name for the ad."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The quote from ugcfans_estimate for exactly this request. Without it the call returns the estimate and makes nothing."
    },
    "voice": {
      "type": "string",
      "maxLength": 128,
      "description": "The voice: the id of a saved voice."
    },
    "person": {
      "type": "string",
      "maxLength": 128,
      "description": "The presenter: the id of a saved person that has a portrait and, for a real person, recorded consent."
    },
    "script": {
      "type": "string",
      "maxLength": 128,
      "description": "A script already written, by its id from ugcfans_write_script."
    },
    "feature": {
      "type": "string",
      "maxLength": 64,
      "description": "What kind of ad, a slug from ugcfans_search_templates such as testimonial, talking-presenter or product-video."
    },
    "product": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1200
        },
        {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 200,
              "description": "The product's name."
            },
            "images": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 512,
                "description": "An address."
              },
              "maxItems": 12,
              "description": "Pictures of it: addresses of library files, out/..."
            },
            "description": {
              "type": "string",
              "maxLength": 1000,
              "description": "What it is and does."
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "What is being sold: a sentence, or an object with its name, description and pictures."
    },
    "reviews": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 800,
        "description": "A review."
      },
      "maxItems": 12,
      "description": "Real customer reviews a testimonial rests on."
    },
    "page_url": {
      "type": "string",
      "maxLength": 2048,
      "description": "A web page to read the product from."
    },
    "template": {
      "type": "string",
      "maxLength": 64,
      "description": "A template slug from ugcfans_search_templates, which fills in the frame, length and shots."
    },
    "testimonial_basis": {
      "enum": [
        "verbatim",
        "edited",
        "composed"
      ],
      "type": "string",
      "description": "Where a testimonial's words come from. verbatim and edited need reviews."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "kind",
    "person"
  ],
  "properties": {
    "kind": {
      "enum": [
        "talking",
        "motion",
        "swap",
        "product"
      ],
      "type": "string",
      "description": "What to make."
    },
    "note": {
      "type": "string",
      "maxLength": 400,
      "description": "swap: what to change, in words."
    },
    "text": {
      "type": "string",
      "maxLength": 5000,
      "description": "talking: words to speak."
    },
    "brand": {
      "type": "string",
      "maxLength": 128,
      "description": "product: the id of a saved brand whose kit holds the product pictures."
    },
    "image": {
      "type": "string",
      "maxLength": 512,
      "description": "talking: which picture of the person to use, out/..."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The held quote for this exact request, after the person confirms its cost."
    },
    "voice": {
      "type": "string",
      "maxLength": 128,
      "description": "talking, with script or text: the id of the saved voice to speak in."
    },
    "person": {
      "type": "string",
      "maxLength": 128,
      "description": "The id of the saved person."
    },
    "script": {
      "type": "string",
      "maxLength": 128,
      "description": "talking: the id of a saved script to speak."
    },
    "source": {
      "type": "string",
      "maxLength": 512,
      "description": "motion and swap: the reference clip's address, out/..."
    },
    "speech": {
      "type": "string",
      "maxLength": 128,
      "description": "talking: the id of a saved line to use as the audio."
    },
    "product": {
      "type": "string",
      "maxLength": 200,
      "description": "product: the product's name."
    },
    "setting": {
      "type": "string",
      "maxLength": 300,
      "description": "motion and product: where it happens."
    },
    "handling": {
      "enum": [
        "held",
        "worn",
        "used",
        "beside"
      ],
      "type": "string",
      "description": "product: how the person has it."
    },
    "motion_from": {
      "enum": [
        "clip",
        "pose"
      ],
      "type": "string",
      "description": "motion: follow the clip itself or its pose (default clip)."
    },
    "product_images": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 512,
        "description": "An address."
      },
      "maxItems": 3,
      "description": "product: pictures of the product, out/..."
    },
    "rights_confirmed": {
      "type": "boolean",
      "description": "motion and swap: the person confirms they may use the source clip."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "kind",
    "name"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 300,
      "description": "brand and product: their web address."
    },
    "kind": {
      "enum": [
        "brand",
        "product",
        "person",
        "voice"
      ],
      "type": "string",
      "description": "What to save."
    },
    "logo": {
      "type": "string",
      "maxLength": 512,
      "description": "brand: the address of its logo, out/..."
    },
    "name": {
      "type": "string",
      "maxLength": 80,
      "description": "Its name."
    },
    "tone": {
      "type": "string",
      "maxLength": 400,
      "description": "brand: its voice, such as warm and plain."
    },
    "brand": {
      "type": "string",
      "maxLength": 128,
      "description": "product: the id of the brand it belongs to."
    },
    "never": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200,
        "description": "A word or claim."
      },
      "maxItems": 50,
      "description": "brand: words and claims its ads never use."
    },
    "claims": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200,
        "description": "A claim."
      },
      "maxItems": 12,
      "description": "product: claims an ad may make about it."
    },
    "images": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 512,
        "description": "An address."
      },
      "maxItems": 12,
      "description": "brand and product: addresses of product pictures, out/..."
    },
    "palette": {
      "type": "object",
      "required": [],
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 7,
          "description": "A colour, #RRGGBB."
        },
        "primary": {
          "type": "string",
          "maxLength": 7,
          "description": "A colour, #RRGGBB."
        },
        "secondary": {
          "type": "string",
          "maxLength": 7,
          "description": "A colour, #RRGGBB."
        },
        "background": {
          "type": "string",
          "maxLength": 7,
          "description": "A colour, #RRGGBB."
        }
      },
      "additionalProperties": false
    },
    "product": {
      "type": "string",
      "maxLength": 600,
      "description": "brand: what the brand sells."
    },
    "tagline": {
      "type": "string",
      "maxLength": 160,
      "description": "brand: its tagline."
    },
    "language": {
      "type": "string",
      "maxLength": 35,
      "description": "voice: its language, as a tag such as en-US."
    },
    "description": {
      "type": "string",
      "maxLength": 1200,
      "description": "product: what it is. person: who the presenter is, drawn from these words."
    },
    "call_to_action": {
      "type": "string",
      "maxLength": 80,
      "description": "brand: what an ad asks the viewer to do."
    },
    "provider_voice": {
      "type": "string",
      "maxLength": 200,
      "description": "voice: the stock voice's name, from the speech models."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "angle": {
      "type": "string",
      "maxLength": 200,
      "description": "The angle or hook to take."
    },
    "brand": {
      "type": "string",
      "maxLength": 128,
      "description": "The id of a saved brand whose voice to follow."
    },
    "hooks": {
      "type": "integer",
      "maximum": 12,
      "minimum": 1,
      "description": "With script: how many alternative openings to write."
    },
    "offer": {
      "type": "string",
      "maxLength": 300,
      "description": "The offer or call to action."
    },
    "quote": {
      "type": "string",
      "maxLength": 4096,
      "description": "The held quote for this exact request, after the person confirms its cost."
    },
    "points": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 300,
        "description": "A point."
      },
      "maxItems": 12,
      "description": "Points the script should make."
    },
    "script": {
      "type": "string",
      "maxLength": 128,
      "description": "The id of a saved script to work on, from an earlier ugcfans_write_script."
    },
    "product": {
      "type": "string",
      "maxLength": 1200,
      "description": "What is being sold, in a sentence or two."
    },
    "seconds": {
      "type": "integer",
      "maximum": 120,
      "minimum": 5,
      "description": "How long the ad runs, 5 to 120 (default 30)."
    },
    "audience": {
      "type": "string",
      "maxLength": 400,
      "description": "Who the ad is for."
    },
    "language": {
      "type": "string",
      "maxLength": 40,
      "description": "The language to write in (default English)."
    },
    "page_url": {
      "type": "string",
      "maxLength": 2048,
      "description": "A web page to read the product from, instead of product."
    },
    "translate_to": {
      "type": "string",
      "maxLength": 40,
      "description": "With script: the language to translate it into."
    }
  },
  "additionalProperties": false
}