Search Subdirs

curl --request GET \
  --url https://api.example.com/api/file/search_subdirs \
  --header 'X-Session-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/file/search_subdirs', 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://api.example.com/api/file/search_subdirs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-API-Key: <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 := "https://api.example.com/api/file/search_subdirs"

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

	req.Header.Add("X-Session-API-Key", "<api-key>")

	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://api.example.com/api/file/search_subdirs")

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

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

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

{
  "items": [
    {
      "name": "<string>",
      "path": "<string>"
    }
  ],
  "next_page_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Files

Search Subdirs

Search / List immediate subdirectories of path.

Used by the GUI’s workspace picker. Symlinks and files are skipped. Hidden entries (names starting with ’.’) are skipped unless include_hidden is True. Returns absolute paths so the GUI can use a result directly as workspace.working_dir.

Results are sorted case-insensitively by name and paginated. page_id is the next_page_id returned by the previous page (the lowercase name of the first item to include on the next page).

GET

api

file

search_subdirs

Search Subdirs

curl --request GET \
  --url https://api.example.com/api/file/search_subdirs \
  --header 'X-Session-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/file/search_subdirs', 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://api.example.com/api/file/search_subdirs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-API-Key: <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 := "https://api.example.com/api/file/search_subdirs"

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

	req.Header.Add("X-Session-API-Key", "<api-key>")

	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://api.example.com/api/file/search_subdirs")

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

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

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

{
  "items": [
    {
      "name": "<string>",
      "path": "<string>"
    }
  ],
  "next_page_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

X-Session-API-Key

string

header

required

Query Parameters

path

string

required

Absolute directory path to list subdirectories of

page_id

string | null

limit

integer

default:100

Required range: x <= 100

include_hidden

boolean

default:false

Response

Successful Response

items

SubdirectoryEntry · object[]

required

Show child attributes

next_page_id

string | null

Guides

Architecture

API Reference

Search Subdirs

Authorizations

Query Parameters

Response