Folders

Get User Personal Folder

get

Get the user's personal folder if it exists.

Authorizations
Responses
200

Successful Response

application/json
Responseany of
nullOptional
get
/folders/me
GET /folders/me HTTP/1.1
Host: api.stack-ai.com
Accept: */*
200

Successful Response

No content

Get Folder

get
Authorizations
Path parameters
folder_idstringRequired
Responses
200

Successful Response

application/json
Responseany
get
/folders/{folder_id}
GET /folders/{folder_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Delete Folder

delete

Delete a folder in the current organization.

Authorizations
Path parameters
folder_idstringRequired
Responses
204

Successful Response

No content
delete
/folders/{folder_id}
DELETE /folders/{folder_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Patch Folder

patch

Update a folder in the current organization.

Authorizations
Path parameters
folder_idstringRequired
Body
anyOptional
Responses
200

Successful Response

application/json
Responseany
patch
/folders/{folder_id}
PATCH /folders/{folder_id} HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*

No content

Query Folders

post

Get all folders for the current user organization.

Args: offset (int): The offset of the folders to return as a number of rows. Defaults to 0. limit (int): The limit of the folders to return as a number of rows. Defaults to 100. query (str): The search query to filter folders by name. If provided, only folders whose names contain the query string will be returned.

Authorizations
Body
anyOptional
Responses
200

Successful Response

application/json
Responseany[]
post
/folders
POST /folders HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*

[]

Create Folder

put

Create a new folder in the current organization.

Authorizations
Body
anyOptional
Responses
201

Successful Response

application/json
Responseany
put
/folders
PUT /folders HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*

No content
PreviousEmbeddingsNextConnections

Was this helpful?