メインコンテンツへスキップ
GET
List Folders

承認

Authorization
string
header
デフォルト:$CARTESIA_API_KEY
必須

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

ヘッダー

Cartesia-Version
enum<string>
デフォルト:2026-03-01
必須

API version header.

利用可能なオプション:
2026-03-01
:

"2026-03-01"

クエリパラメータ

parent_ids[]
string[]

Filter to folders with these parent IDs. Repeat the parameter to pass multiple values (e.g., ?parent_ids[]=folder_abc&parent_ids[]=null). Pass the literal string null to include top-level folders. Defaults to [null] (top-level folders only).

depth
integer
デフォルト:3

How many levels of nested children to include in the response, between 1 and 3. Defaults to 3.

必須範囲: 1 <= x <= 3
starting_after
string

A cursor for pagination. Pass the ID of the last folder from the previous page to fetch the next page.

ending_before
string

A cursor for pagination. Pass the ID of the first folder from the previous page to fetch the previous page.

limit
integer
デフォルト:10

The number of folders to return per page, ranging between 1 and 100. Defaults to 10. Pagination applies to the top-level folders in the response; nested children do not count against this limit.

必須範囲: 1 <= x <= 100

レスポンス

200 - application/json

A paginated tree of folders.

data
FolderTreeResponse · object[]
必須

The paginated list of top-level folders matching the request.

has_more
boolean
必須

Whether more results are available after this page.

next_page
string | null

An ID that can be passed as starting_after or ending_before to get the next page.