Read a published Ravi Page's content by URL
curl --request POST \
--url http://localhost:3000/api/v1/pages/read \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"console": "<string>",
"cursor": "<string>",
"customDomain": true,
"format": "<string>",
"maxChars": "<string>",
"out": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/read"
payload = {
"url": "<string>",
"console": "<string>",
"cursor": "<string>",
"customDomain": True,
"format": "<string>",
"maxChars": "<string>",
"out": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
console: '<string>',
cursor: '<string>',
customDomain: true,
format: '<string>',
maxChars: '<string>',
out: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'console' => '<string>',
'cursor' => '<string>',
'customDomain' => true,
'format' => '<string>',
'maxChars' => '<string>',
'out' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/pages/read"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/pages/read")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/read")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"consoleUrl": "<string>",
"content": {
"cursor": 123,
"format": "markdown",
"nextCursor": 123,
"note": "<string>",
"representation": "extracted_markdown",
"text": "<string>",
"totalChars": 123,
"truncated": true
},
"contentTrust": "untrusted",
"links": [
{
"text": "<string>",
"url": "<string>"
}
],
"page": {
"artifact": {
"id": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"description": "<string>",
"file": {
"contentType": "<string>",
"path": "<string>",
"sha256": "<string>",
"sizeBytes": 123
},
"host": "<string>",
"path": "<string>",
"projectId": "<string>",
"release": {
"id": "<string>",
"number": 123
},
"route": {
"id": "<string>",
"matchType": "<string>",
"path": "<string>"
},
"siteId": "<string>",
"title": "<string>",
"url": "<string>",
"visibility": "<string>"
},
"publicOnly": true,
"routes": [
{
"matchType": "<string>",
"path": "<string>",
"url": "<string>",
"visibility": "<string>"
}
],
"signals": {
"raviElements": [
"<string>"
],
"renderSuggested": true,
"scripts": 123,
"staticTextChars": 123
},
"success": true,
"download": {
"files": [
{
"contentType": "<string>",
"entrypoint": true,
"path": "<string>",
"sizeBytes": 123
}
],
"kind": "directory",
"path": "<string>",
"totalBytes": 123
}
}pages
Read a published Ravi Page's content by URL
POST
/
api
/
v1
/
pages
/
read
Read a published Ravi Page's content by URL
curl --request POST \
--url http://localhost:3000/api/v1/pages/read \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"console": "<string>",
"cursor": "<string>",
"customDomain": true,
"format": "<string>",
"maxChars": "<string>",
"out": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/read"
payload = {
"url": "<string>",
"console": "<string>",
"cursor": "<string>",
"customDomain": True,
"format": "<string>",
"maxChars": "<string>",
"out": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
console: '<string>',
cursor: '<string>',
customDomain: true,
format: '<string>',
maxChars: '<string>',
out: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'console' => '<string>',
'cursor' => '<string>',
'customDomain' => true,
'format' => '<string>',
'maxChars' => '<string>',
'out' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/pages/read"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/pages/read")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/read")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"customDomain\": true,\n \"format\": \"<string>\",\n \"maxChars\": \"<string>\",\n \"out\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"consoleUrl": "<string>",
"content": {
"cursor": 123,
"format": "markdown",
"nextCursor": 123,
"note": "<string>",
"representation": "extracted_markdown",
"text": "<string>",
"totalChars": 123,
"truncated": true
},
"contentTrust": "untrusted",
"links": [
{
"text": "<string>",
"url": "<string>"
}
],
"page": {
"artifact": {
"id": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"description": "<string>",
"file": {
"contentType": "<string>",
"path": "<string>",
"sha256": "<string>",
"sizeBytes": 123
},
"host": "<string>",
"path": "<string>",
"projectId": "<string>",
"release": {
"id": "<string>",
"number": 123
},
"route": {
"id": "<string>",
"matchType": "<string>",
"path": "<string>"
},
"siteId": "<string>",
"title": "<string>",
"url": "<string>",
"visibility": "<string>"
},
"publicOnly": true,
"routes": [
{
"matchType": "<string>",
"path": "<string>",
"url": "<string>",
"visibility": "<string>"
}
],
"signals": {
"raviElements": [
"<string>"
],
"renderSuggested": true,
"scripts": 123,
"staticTextChars": 123
},
"success": true,
"download": {
"files": [
{
"contentType": "<string>",
"entrypoint": true,
"path": "<string>",
"sizeBytes": 123
}
],
"kind": "directory",
"path": "<string>",
"totalBytes": 123
}
}Body
application/json
Ravi Page URL, such as https://acme.ravi.page/weekly
Console base URL
Character offset to continue a long page (from nextCursor)
Allow a host that is not *.ravi.page (a custom Pages domain)
markdown (default, text only), html (entry source), zip or files (every published file, with --out)
Characters to return (1000-256000, default 256000)
Where --format zip writes the .zip, or --format files the directory
Response
Success — body conforms to the @Returns schema.
Show child attributes
Show child attributes
Allowed value:
"untrusted"Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes