Documentation IndexFetch the complete documentation index at: /docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Contact support
cURL
curl --request GET \ --url http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id} \ --header 'Authorization: <api-key>'
import requests url = "http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}" headers = {"Authorization": "<api-key>"} response = requests.get(url, headers=headers) print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}}; fetch('http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}', 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 => "3001", CURLOPT_URL => "http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: <api-key>" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
package main import ( "fmt" "net/http" "io" ) func main() { url := "http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "<api-key>") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) }
HttpResponse<String> response = Unirest.get("http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}") .header("Authorization", "<api-key>") .asString();
require 'uri' require 'net/http' url = URI("http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Authorization"] = '<api-key>' response = http.request(request) puts response.read_body
{ "ID": 1, "Content": "# Title\r\n## Subtitle\r\nContent goes here", "MarkdownEnabled": true, "Status": "published", "Title": "Get started this API Product", "Lede": "<string>", "Type": "<string>", "Path": "<string>", "Categories": [ "<string>" ], "Tags": [ "<string>" ], "CreatedAt": "2023-06-25 13:37", "UpdatedAt": "2023-06-25 13:37" }
Get a tutorial page
UID of an API Product
1
UID of a tutorial page
OK
Unique identifier for the post
Content of this tutorial page. If MarkdownEnabled is true then content of this tutorial page is treated as Markdown text and as HTML otherwise
MarkdownEnabled
"# Title\r\n## Subtitle\r\nContent goes here"
Switches content between Markdown and HTML versions
true
Status of the post (e.g., draft, published)
published
draft
review
"published"
Title of the post
"Get started this API Product"
Short summary or lead paragraph of the post
Type of the post (e.g., article, news)
URL path for the post
List of categories associated with the post
List of tags associated with the post
Timestamp of when this post was created
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
"2023-06-25 13:37"
Timestamp of when this post was last updated
Was this page helpful?