Skip to main content
GET
Read a web page

Authorizations

X-API-Key
string
header
required

Query Parameters

url
string
required

The page's address; one without http:// or https:// is read over https.

Required string length: 1 - 2048

Response

Successful Response

One web page as the AI Assistant read it, or why it could not.

content
string
required

The page's text as markdown, capped; empty when nothing could be read.

ok
boolean
required

Whether readable text came back.

reads_left
integer | null
required

Page reads the workspace has left today after this one; null when the count is not known.

reason
string | null
required

Why nothing could be read, phrased for a person; null when the read worked.

resets_at
string<date-time>
required

When today's page reads come back: the next midnight UTC.

title
string | null
required

The page's title, when it has one.

url
string
required

The address read, as the reader settled on it (https added, a redirect followed).