Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List a task's working-directory files

The root of the task's working directory.

GET /tasks/{id}/files/list

cURL
curl --request GET \
  --url https://{host}/api/tasks/{id}/files/list \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Pinecone-Api-Version: <x-pinecone-api-version>'
Python
import requests

url = "https://{host}/api/tasks/{id}/files/list"

headers = {
    "Authorization": "Bearer <token>",
    "X-Pinecone-Api-Version": "<x-pinecone-api-version>"
}

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

print(response.text)
JavaScript
const options = {method: "GET", headers: {"Authorization": "Bearer <token>", "X-Pinecone-Api-Version": "<x-pinecone-api-version>"}};

fetch("https://{host}/api/tasks/{id}/files/list", options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/tasks/{id}/files/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Pinecone-Api-Version: <x-pinecone-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/tasks/{id}/files/list"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Pinecone-Api-Version", "<x-pinecone-api-version>")

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

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

	fmt.Println(string(body))

}
Java
HttpResponse<String> response = Unirest.get("https://{host}/api/tasks/{id}/files/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
  .asString();
Ruby
require 'uri'
require 'net/http'

url = URI("https://{host}/api/tasks/{id}/files/list")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Pinecone-Api-Version"] = '<x-pinecone-api-version>'

response = http.request(request)
puts response.read_body
200
{
  "entries": [
    {
      "name": "<string>",
      "kind": "<string>",
      "size": 123,
      "mtime": "<string>"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123,
  "next_offset": 123
}
404
{
  "message": "<string>",
  "code": "<string>"
}
Authorizationstringrequired

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

X-Pinecone-Api-Version?string

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.

Typestring
Default2026-07
idstringrequired

Task id.

Typestring
offset?integer

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

Typeinteger
limit?integer

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

Typeinteger

200 — Directory listing

Read after the task's files were archived.

entriesobject[]required

The directory's immediate children.

Typeobject[]
Show child attributes
namestringrequired

Entry name, not a full path.

Typestring
kindstringrequired

Whether the entry is a file or a directory.

Typestring
sizeintegerrequired

Byte size. 0 for a directory.

Typeinteger
mtimestringrequired

RFC3339 last-modified, or empty when the store reports none.

Typestring
totalintegerrequired

Entries in the directory.

Typeinteger
offsetintegerrequired

Where this page starts.

Typeinteger
limitintegerrequired

Maximum entries in this page.

Typeinteger
next_offsetinteger | nullrequired

Null on the last page.

Typeinteger | null
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu