Jobs
Create Job
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
Jobs
Create Job
POST
/
v2
/
create_job
object
*
job_creation_info
object
*
job_creation_info
Required
object
associated_ui
object
associated_ui
object
Sheet
string
*
Sheet
Required
string
is_hidden
boolean
is_hidden
boolean
scope
object
*
scope
Required
object
Job's scope which includes both Local entries (vrkai stored locally only in job) and VecFS entries (source/vector resource stored in the FS, accessible to all jobs)
local_vrkai
array
*
local_vrkai
Required
array
local_vrpack
array
*
local_vrpack
Required
array
network_folders
array
*
network_folders
Required
array
vector_fs_folders
array
*
vector_fs_folders
Required
array
vector_fs_items
array
*
vector_fs_items
Required
array
llm_provider
string
*
llm_provider
Required
string
Initialize a new job within the system with specified parameters.
Body
application/json
job_creation_info
object
requiredllm_provider
string
requiredResponse
200 - application/json
The response is of type any
.