Using the Frametap App
The Frametap web app lives at frametap.io/app. It is the easiest way to enroll runners, create jobs, review captures, manage keys, and monitor billing.
Main Areas
Dashboard
Open frametap.io/app to see:
- runner health and readiness
- current credit state
- recent recordings and screenshots
- recent jobs and job activity
Use the dashboard when you want a quick health check before creating jobs or troubleshooting a runner.
Runners
Use Runners to connect machines and inspect runner details.
The first-run onboarding flow in the app is:
- Create a runner enrollment key
- Copy the install command
- Run
frametap up --token ...on the target machine - Wait for the runner to appear as ready
- Create the first job
Once a runner is connected, the app lets you:
- inspect hostname, platform, displays, and scopes
- rename a runner
- delete a runner
- start job creation from that runner
Jobs
Use Jobs to create and manage capture jobs.
The create-job flow in the app follows this sequence:
- choose a runner
- choose a job type
- choose one-time or recurring execution
- for recordings, choose a stop condition
- give the job a name if needed
- pick the display to capture
The app currently exposes screenshot and recording creation directly in the UI.
Recordings
Use Recordings to review artifacts created by Frametap.
This page is where users:
- browse recordings and screenshots
- switch between grid and table views
- preview media
- download files
- rename titles
- delete artifacts
Although the route is called recordings, it is the main artifact browser for Frametap documents.
Settings
The main settings sections are:
In API Keys, users create:
- runner enrollment keys for connecting machines
- access keys for the public API
In Billing, users can:
- view plan and credits
- buy credits
- change plan
- open subscription management
When to Use the App vs API
Use the App when you want to:
- enroll a runner quickly
- create one-off jobs manually
- inspect runner status
- review artifacts visually
- manage keys and billing
Use the API when you want to:
- trigger jobs from CI or automation
- manage runners programmatically
- retrieve documents in scripts
- build your own tooling around Frametap
Use the full API reference here:
Suggested First Workflow
- Open API Keys
- Create a runner enrollment key
- Install the CLI on your machine
- Run
frametap up --token ... - Confirm the runner appears in Runners
- Create a job in Jobs
- Review the result in Recordings