Documentation
Quickstart
Sign up, create a key, first call in five minutes.
- 1.Sign up and verify your email.
- 2.Create an API key in the dashboard — copy it once.
- 3.Call /v1/read with a URL — that is a working integration.
Fetch a URL and return clean extracted text. Tries the cache first, then HTTP, then an isolated headless browser for JS-heavy pages.
Request
| Field | Type | Description | |
|---|---|---|---|
url | string | required | The page URL to read (http/https). |
maxChars | integer | optional | Cap on returned characters (default 200,000). |
format | 'markdown' | 'text' | optional | Extraction format — markdown keeps structure, text is plain. |
forceBrowser | boolean | optional | Skip the HTTP attempt and render in the isolated browser directly. |
Example
curl -X POST https://agw.orcanox.xyz/v1/read \ -H "Authorization: Bearer agw_…" \ -H "Content-Type: application/json" \ -d '{"url":"https://example.com"}'
import requests r = requests.post("https://agw.orcanox.xyz/v1/read", headers={"Authorization": "Bearer agw_…"}, json={"url":"https://example.com"}) print(r.status_code, r.json())
const r = await fetch("https://agw.orcanox.xyz/v1/read", { method: "POST", headers: { "Authorization": "Bearer agw_…", "Content-Type": "application/json" }, body: JSON.stringify({"url":"https://example.com"}) }); console.log(r.status, await r.json());
Response
json
{
"url": "https://example.com",
"finalUrl": "https://example.com/",
"status": 200,
"title": "Example Domain",
"content": "This domain is for use in illustrative examples…",
"contentType": "text/html; charset=UTF-8",
"chars": 1256,
"truncated": false,
"blocks": 5,
"linkCharsRatio": 0.12,
"contentKind": "article",
"fetchedVia": "http",
"method": "http",
"tookMs": 41,
"renderReason": null,
"cached": true,
"latencyMs": 42
}Errors
| Status | code | Example |
|---|---|---|
| 400 | bad_request | {"code":"bad_request","message":"invalid url"} |
| 502 | fetch_failed | {"code":"fetch_failed","message":"upstream returned 404"} |
| 504 | fetch_timeout | {"code":"fetch_timeout","message":"deadline exceeded"} |