Get Started

An introduction to the Gaffa Browser API. Learn how you can get started building fast, powerful web automations!

Welcome to the Gaffa documentation site! You'll find everything you need here to get started using API including interactive API definitions, a comprehensive list of actions you can use to interact with our cloud browsers and breakdowns of our example requests you can run right away in our API Playground.

Gaffa is currently in it's very early stages, so we'd love to hear how we can improve our docs and API to make life easier for our users. If you have any questions or comments please email us or us the support tool on our site. To stay up to date with latest developments, features and news on mission to support the development of revolutionary AI Agents, sign up to sporadic newsletter updates.

1

Create an account

You can sign up to create a Gaffa account here. After signing up you'll immediately be able to use the API to start using our API Playground which has a number of pre-built automations for our demo site simulating a range of scenarios.

Accessing the open web

When you're ready to use Gaffa on the open web you'll need to choose a plan suitable for your needs and pay at which point the full internet will be available for you to automate.

In order to avoid scaling issues for our existing customers we are currently operating a queuing system for new accounts. Simply join the queue when prompted on your account dashboard and we'll let you know when you have access. If you want to jump the queue, you can fill out a short survey to help us better understand our users and we'll approve your account sooner!

2

Making your first browser request

The easiest way to make your first Gaffa browser request is to start using our API Playground where you can see several pre-made and interactive browser request examples of automations we've built against our test site which simulates some common scraping and web automation scenarios. You can run these examples without a paid account and also edit them easily to experiment - once you have a paid account you can also use the playground to build your automations for other sites.

Gaffa API Playground examples

Here are all the sample requests we've created for use in the API Playground.

Print to PDF

Export a web page to PDF and wait for elements to load with the Gaffa API.

Convert to Markdown

Export a web page to markdown format - useful feeding into LLM apps.

Infinitely Scroll

Scroll the bottom of a page that infinitely loads items and record the interaction.

Capture Screenshot

Interact with a page and capture the a screenshot of the whole page.

Form Completion

Fill out a form in a human-like way and record the interaction

3

Building your own browser requests

Once you have a paid account and are ready to start building your own browser requests you'll want to read about all the other actions you can use for your solution as well as how you can easily use proxy servers, our cache as well as the other endpoints that are part of the API.