Run a Mod

Run the Pika Effects Mod

Apply video effects designed to modify objects, characters, and environments in a fun, engaging, and visually compelling manner.

POST
/mods/4e5a25bb-318c-4095-b600-ccc5b376039a/run
/mods/4e5a25bb-318c-4095-b600-ccc5b376039a/run

The Authorization access token

Authorization

API-Key<token>

API key. Example: "API-Key": "<apiKey>"

In: header

Authorization
Required
Bearer <token>

Session token. Example: "Authorization": "Bearer <token>"

In: header

Request Body

application/jsonRequired

parameters
Required
object

curl -X POST "https://api.endless.io/v1/mods/4e5a25bb-318c-4095-b600-ccc5b376039a/run" \
  -H "API-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "effect": "Tear",
      "main_image": {
        "type": "image",
        "url": "https://endless.supabase.co/storage/v1/object/public/static/image.png"
      }
    }
  }'

Success

{
  "type": "video",
  "url": "https://www.youtube.com/watch?v=V3rTaj7zdoc"
}

Previous

Run the Mapa Mental Mod POST

Next

Run the 60s Radio Announcer Mod. POST