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

export SENTIENCE_API_KEY="sk_live_..."

02 Execute Observation

curl -X POST https://api.sentienceapi.com/v1/observe \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://news.ycombinator.com",
    "mode": "map",
    "options": {
      "render_quality": "performance"
    }
  }'

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 →

Geometry Map (Recommended)

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

Authentication