</>olaapiPlayground ↗
VERSION 1 · PRIVATE BETA

Ola API documentation

A consistent JSON data contract developed as a standalone service. Current extraction is limited to approved demonstration domains and requires an operator-provisioned beta key.

Overview

Base URL: https://api.olacheap.com (public preview only after the production deployment and DNS/TLS checks succeed). Successful JSON responses use data and meta; errors use error and meta.

Authentication

Use x-api-key on server-side requests. Never embed a key in browser code. Multi-tenant key generation, scopes and rotation are planned, not yet active.

POST /v1/extract

Extract title, description and readable text from static HTML pages. The beta permits exactly example.com, www.iana.org and developer.mozilla.org. Other hosts, redirects, unsafe protocols and oversized responses are rejected. No JavaScript rendering or anti-bot bypass.

curl -X POST https://api.olacheap.com/v1/extract \
  -H 'x-api-key: YOUR_BETA_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","mode":"text"}'

JSON body: {"url":"https://example.com","mode":"text"}. Modes: text and metadata.

GET /v1/catalog

Read-only catalog with truthful statuses. Only restricted Web Extract is private beta; the other categories are roadmap items.

Errors & limits

Standard codes include unauthorized, host_not_allowed, invalid_json, upstream_unavailable, response_too_large and beta_disabled. There are no credit deductions in the initial beta.

Launch status

Global scraping, browser rendering, proxies, customer key management, shared credit billing, SSO, dashboards, SDKs and MCP remain unimplemented. Do not purchase or sell access to unavailable features.

← Back to Ola API