Extractbase Docs home pagelight logodark logo
  • Live Demo
  • Sign up
  • Sign up
API Reference

Extractbase API Reference

Welcome to the Extractbase documentation

Full documentation and guides are coming soon. In the meantime, please have a look at our API reference docs, try out the live demo, and sign up to the beta list for early access.

Extractbase – Query the web like it's an API

​
Queries

Page

Navigate to a URL, load HTML content, or access the current page.

Content

Retrieve the fully rendered HTML content of pages.

Markdown

Convert pages to clean markdown for LLMs.

Screenshot

Captures screenshots of rendered pages.

PDF

Generate PDF files from pages.

​
AI Mutations

Act

Instruct the browser to take an action in natural language.

Extract

Extract data from the page with a description and a JSON schema.

Observe

Identify relevant page content and interactive elements.

Assistant
Responses are generated using AI and may contain mistakes.
x
Powered by Mintlify
On this page
  • Queries
  • AI Mutations
Queries
  • page
Page Queries
  • ariaSnapshot
  • attribute
  • attributes
  • boundingBox
  • browserVersion
  • content
  • cookies
  • element
  • elements
  • innerHTML
  • innerText
  • markdown
  • pdf
  • performance
  • response
  • screenshot
  • status
  • storageState
  • textContent
  • title
  • url
  • userAgent
  • viewport
AI Mutations
  • act
  • extract
  • observe
Browser Mutations
  • addCookies
  • addInitScript
  • addScriptTag
  • addStyleTag
  • blur
  • check
  • clear
  • clearCookies
  • clearPermissions
  • click
  • dragAndDrop
  • emulateMedia
  • evaluate
  • events
  • fill
  • focus
  • goBack
  • goForward
  • grantPermissions
  • highlight
  • hover
  • keyPress
  • keyType
  • page
  • reload
  • scrollIntoView
  • selectOption
  • selectText
  • setExtraHTTPHeaders
  • setGeolocation
  • setInputFiles
  • setOffline
  • setViewport
  • tap
  • touch
  • uncheck
  • waitForEvent
  • waitForFunction
  • waitForLoadState
  • waitForRequest
  • waitForResponse
  • waitForURL
Subscriptions
  • console
  • execution
  • pageError
  • request
  • response
  • screencastFrame
Objects
  • BoundingBox
  • ConsoleMessage
  • ConsoleMessageLocation
  • Cookie
  • Coordinates
  • Download
  • Element
  • Error
  • Events
  • Execution
  • Mutation
  • Observe
  • Page
  • Performance
  • Query
  • Request
  • RequestFailure
  • RequestSizes
  • RequestTiming
  • Response
  • ScreencastFrame
  • ScreencastFrameMetadata
  • SecurityDetails
  • ServerAddress
  • StorageState
  • Subscription
  • Viewport
Inputs
  • ActOptions
  • AddInitScriptOptions
  • AddScriptTagOptions
  • AddStyleTagOptions
  • AuthCredentialOptions
  • BlockAdsOptions
  • BlockRequestsOptions
  • BoxOptions
  • CheckOptions
  • ClearCookiesOptions
  • ClearOptions
  • ClickOptions
  • CookieOptions
  • DragAndDropOptions
  • ElementFilterOptions
  • ElementOptions
  • EmulateMediaOptions
  • ExtractOptions
  • FillOptions
  • GeolocationOptions
  • GrantPermissionsOptions
  • HoverOptions
  • InputFileOptions
  • KeyPressOptions
  • KeyTypeOptions
  • ObserveOptions
  • PageOptions
  • PDFMarginOptions
  • PDFOptions
  • PointOptions
  • ProxyOptions
  • ScreenOptions
  • ScreenshotOptions
  • SelectOptionOptions
  • SelectTextOptions
  • SelectValueOptions
  • StorageStateOptions
  • TapOptions
  • TimeoutOptions
  • ViewportOptions
  • WaitForFunctionOptions
  • WaitForOptions
Enums
  • ARIARole
  • BufferEncoding
  • ColorScheme
  • Contrast
  • Device
  • DragOperation
  • ExecutionState
  • ForcedColors
  • LifecycleEvent
  • LoadState
  • MediaType
  • ModifierKey
  • MouseButton
  • PageEvent
  • PaperFormat
  • Permission
  • Polling
  • ReducedMotion
  • ResourceType
  • SameSite
  • ScreenshotAnimations
  • ScreenshotCaret
  • ScreenshotScale
  • ScreenshotType
  • ServiceWorkerRegistration
Directives
  • @oneOf
  • @skipErrors

Extractbase API Reference

Welcome to the Extractbase documentation

Full documentation and guides are coming soon. In the meantime, please have a look at our API reference docs, try out the live demo, and sign up to the beta list for early access.

Extractbase – Query the web like it's an API

​
Queries

Page

Navigate to a URL, load HTML content, or access the current page.

Content

Retrieve the fully rendered HTML content of pages.

Markdown

Convert pages to clean markdown for LLMs.

Screenshot

Captures screenshots of rendered pages.

PDF

Generate PDF files from pages.

​
AI Mutations

Act

Instruct the browser to take an action in natural language.

Extract

Extract data from the page with a description and a JSON schema.

Observe

Identify relevant page content and interactive elements.

Assistant
Responses are generated using AI and may contain mistakes.
x
Powered by Mintlify
On this page
  • Queries
  • AI Mutations