API Reference

Complete HTTP API documentation for Gaffa. Each endpoint page includes interactive OpenAPI definitions you can try from the docs.

Start with API Authentication to create and use API keys, then explore the endpoints below.

Browser requests

• POST v1/browser/requests — Create and run a browser request

• GET v1/browser/requests/{id} — Get a browser request by ID

• GET v1/browser/requests — List browser requests

Schemas

• POST v1/schemas — Create a schema

• PUT v1/schemas — Update a schema

• GET v1/schemas — List schemas

• DELETE v1/schemas/{id} — Delete a schema

Site mapping

• POST v1/site/map — Create a site mapping request

• GET v1/site/map — List site mapping requests

• GET v1/site/map/{id} — Get a site mapping request by ID