Skip to main content
This quickstart takes you from a fresh machine to a working Figranium task. You will install Figranium with Docker Compose, create a task in the visual editor, run it once, and then trigger the same task through the REST API.

1. Install Figranium

1

Create a project directory

Create a folder for your Figranium installation:
2

Download the Docker Compose file

Download the official deployment configuration:
The deployment file pulls the pre-built Figranium image, so you do not need to clone the repository or build it locally.
3

Start Figranium

Launch the container:
Docker will pull the latest Figranium image and start the application.
4

Open the UI

Open http://localhost:11345 in your browser and complete the initial setup screen.
For persistent sessions across container restarts, add a SESSION_SECRET to your Compose configuration. See Docker Compose for the complete deployment file, volume mounts, update instructions, and production notes.

2. Create your first task

From the Figranium dashboard:
1

Create a task

Click New Task. Give the task a name such as Example Page and set the target URL to:
2

Add an action

In the editor, press Cmd/Ctrl + K or use the add-action control to open the Action Palette.Add a Get Content action and configure it to extract the page content you want returned by the task.
3

Save the task

Save the task. Figranium stores the task definition on your own instance and gives it a stable task ID.
Figranium tasks are built from deterministic action blocks. You can add clicks, typing, waits, JavaScript, extraction, control flow, uploads, downloads, and more. See Action Blocks for the full block reference.

3. Run it in the editor

Click Run Task, or press Cmd/Ctrl + Enter. The results drawer opens automatically and shows the run as it progresses. When the task finishes, you can inspect:
  • the execution status
  • the activity log
  • extracted data
  • screenshots or recordings, when enabled
Every run is also recorded under Executions so you can inspect it later.

4. Trigger the same task through the API

Figranium exposes every saved task through a stable endpoint:
You can copy the complete endpoint directly from the task editor’s API view. First, generate or copy an API key from Settings > API Keys. Then call the task:
A request body is optional. If your task uses variables, pass them as JSON:
Treat your API key like a password. Do not commit it to source control or expose it in public screenshots.

5. Build from here

You now have one task that can run from both the visual editor and the API. The same task can also be scheduled, called from an SDK, exposed through MCP, or connected to workflow platforms.

UI Tour

Learn the Dashboard, Editor, Executions, Cabinets, and Settings.

Action Blocks

Browse every block available for building browser workflows.

Variables

Make tasks reusable with runtime values such as {$query}.

REST API

Explore task execution, schedules, executions, browser control, and more.

SDKs

Use Figranium from JavaScript, Python, Swift, or Kotlin.

MCP

Connect Figranium tasks to MCP-compatible AI clients.