Docs/Quick Start

Initialize the Observer

Give your AI agent sight in less than 5 minutes. Transform raw HTML into structured, interactable geometry data.

01 Authenticate

Access control is managed via Bearer tokens. You can generate a persistent key from your terminal dashboard.

  • Create Account
  • Generate sk_live_... Key
  • Export to Environment

Generate API Key →

export PREDICATE_API_KEY="sk_live_..."

02 Execute Observation

No code found

Parameters

  • url (REQUIRED) - Target website to observe.
  • mode (ENUM) - Controls the extraction engine:
    • "read" (Markdown)
    • "map" (Geometry) - Recommended
    • "visual" (Screenshot)

03 Parse Geometry

Reader Stream

Pure Markdown extraction for RAG pipelines.

  • 1 Credit
  • ~300ms

Learn more →

Coordinate tree of interactive elements for Agents.

  • 2 Credits
  • ~500ms

Learn more →

Visual Matrix

Precision rendering + Screenshots for Vision Models.

  • 10 Credits
  • ~2000ms

Learn more →


Need help? Contact Engineering