List all pages

Returns every file in the documentation repository with its path and size in bytes.

curl -X GET "https://api.documentationai.app/api/v1/pages?branch=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://api.documentationai.app/api/v1/pages?branch=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.documentationai.app/api/v1/pages?branch=example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.documentationai.app/api/v1/pages?branch=example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.documentationai.app/api/v1/pages?branch=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "pages": [
    {
      "path": "getting-started/introduction.mdx",
      "size": 2048
    }
  ],
  "count": 10
}

GET

/pages

GET

Bearer Token

Bearer Tokenstring

Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

query

branchstring

Branch name. Defaults to the deployment branch.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Query Parameters

branchstring

Branch name. Defaults to the deployment branch.

Responses

pagesarray

pathstring

sizeinteger

File size in bytes

countinteger

statusCodeinteger

errorstring

messagestring

Was this page helpful?

Last updated 2 days ago

Built with Documentation.AI