Subscriptions
Create Shareable Folder
API Documentation
General
- POSTAdd LLM Provider
- POSTAdd Ollama Models
- POSTChange Node Name
- GETGet Default Embedding Model
- POSTSet Default Embedding Model
- GETDownload File from Inbox
- GETAPI Health Check
- POSTInitial Registration
- GETCheck Pristine State
- GETList Files in Inbox
- GETGet Local Processing Preference
- POSTSet Local Processing Preference
- POSTModify LLM Provider
- GETGet Public Keys
- POSTRemove LLM Provider
- GETScan Ollama Models
- POSTStop LLM Process
- GETGet Supported Embedding Models
- POSTUpdate Supported Embedding Models
Jobs
- POSTAdd File to Inbox
- GETGet All Inboxes
- GETGet Available LLM Providers
- POSTChange Job LLM Provider
- POSTCreate Files Inbox
- POSTCreate Job
- GETGet Job Configuration
- GETGet Job Scope
- POSTSend Job Message
- POSTGet Last Messages
- POSTGet Last Messages with Branches
- POSTRetry Message
- POSTUpdate Job Configuration
- POSTUpdate Job Scope
- POSTUpdate Smart Inbox Name
Subscriptions
- POSTGet Available Shared Items
- POSTGet Open Shared Items
- POSTCreate Shareable Folder
- POSTGenerate Free Subscription Links
- POSTGet Latest Notifications
- POSTList My Subscribers
- POSTList My Subscriptions
- POSTGet Notifications Before Timestamp
- POSTSubscribe to Shared Folder
- POSTUnshare Folder
- POSTUnsubscribe
- POSTUpdate Shareable Folder
Tool Offerings
Vector File System
Subscriptions
Create Shareable Folder
POST
/
v2
/
create_shareable_folder
curl --request POST \
--url http://127.0.0.1:9550/v2/create_shareable_folder \
--header 'Content-Type: application/json' \
--data '{
"credentials": {
"access_key_id": "<string>",
"bucket": "<string>",
"endpoint_uri": "<string>",
"secret_access_key": "<string>",
"source": "S3"
},
"path": "<string>",
"subscription_req": {
"folder_description": "<string>",
"has_web_alternative": true,
"is_free": true,
"minimum_time_delegated_hours": 1,
"minimum_token_delegation": 1,
"monthly_payment": {
"USD": 123
}
}
}'
"<string>"
Create a new folder that can be shared with other users for collaboration or viewing.
Body
application/json
Required range:
x > 0
Required range:
x > 0
Response
200
text/plain
Successfully created shareable folder
The response is of type string
.
Was this page helpful?
curl --request POST \
--url http://127.0.0.1:9550/v2/create_shareable_folder \
--header 'Content-Type: application/json' \
--data '{
"credentials": {
"access_key_id": "<string>",
"bucket": "<string>",
"endpoint_uri": "<string>",
"secret_access_key": "<string>",
"source": "S3"
},
"path": "<string>",
"subscription_req": {
"folder_description": "<string>",
"has_web_alternative": true,
"is_free": true,
"minimum_time_delegated_hours": 1,
"minimum_token_delegation": 1,
"monthly_payment": {
"USD": 123
}
}
}'
"<string>"