List the source file tree (root) - Pinecone Docs

List the source file tree (root)

curl --request GET \
  --url https://{host}/api/contexts/{slug}/source/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/contexts/{slug}/source/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/contexts/{slug}/source/list",
  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: Bearer <token>"
  ],
]);

$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 := "https://{host}/api/contexts/{slug}/source/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/contexts/{slug}/source/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "entries": [
    {
      "name": "<string>",
      "kind": "<string>",
      "size": 123,
      "mtime": "<string>"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123,
  "next_offset": 123
}

{
  "message": "<string>",
  "code": "<string>"
}

GET

/

contexts

/

{slug}

/

source

/

list

List the source file tree (root)

curl --request GET \
  --url https://{host}/api/contexts/{slug}/source/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/contexts/{slug}/source/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/contexts/{slug}/source/list",
  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: Bearer <token>"
  ],
]);

$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 := "https://{host}/api/contexts/{slug}/source/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/contexts/{slug}/source/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "entries": [
    {
      "name": "<string>",
      "kind": "<string>",
      "size": 123,
      "mtime": "<string>"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123,
  "next_offset": 123
}

{
  "message": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Session token from POST /auth/login, sent as Authorization: Bearer <token>.

Headers

X-Pinecone-Api-Version

string

default:2026-07

Date-based contract version, echoed back on the same header. Omit for the default (2026-07); send unstable for the in-development surface. An unrecognized value is rejected with 400 unsupported_api_version.

Path Parameters

slug

string

required

Context slug or UUID.

Query Parameters

offset

integer<int64>

Where the page starts. Source and knowledge listings echo it rather than applying it, since they return the whole directory in one page.

limit

integer<int64>

Maximum entries in the page. Source and knowledge listings echo it rather than applying it, since they return the whole directory in one page.

Response

Directory listing

One page of a source or knowledge directory. A listing returns a single page, so offset is 0 and next_offset is null; limit echoes the request rather than being applied.

entries

object[]

required

The directory's immediate children.

Show child attributes

total

integer<int64>

required

Entries in this directory.

offset

integer<int64>

required

Echoes the request.

limit

integer<int64>

required

Echoes the request.

next_offset

integer<int64> | null

Always null — a listing returns one page.