Skip to main content
POST
Read website text

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of read_website_text.

url
string
required

The team's website, with or without https:// (the probe's final_url when it answered).

Required string length: 1 - 2048
max_pages
integer

How many pages at most, the home page counted; default 5.

Required range: 1 <= x <= 5

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required