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
Update Job Scope
POST
/
v2
/
update_job_scope
curl --request POST \
--url http://127.0.0.1:9550/v2/update_job_scope \
--header 'Content-Type: application/json' \
--data '{
"job_id": "<string>",
"job_scope": {
"local_vrkai": [
{
"vrkai": {
"metadata": {},
"resource": {
"Document": {
"created_datetime": "2023-12-25",
"data_tag_index": {
"index": {}
},
"description": "<string>",
"distribution_info": {
"datetime": "2023-12-25",
"origin": {
"Uri": "<string>"
}
},
"embedding_model_used_string": "<string>",
"embeddings": [
{
"id": "<string>",
"vector": [
123
]
}
],
"keywords": {
"keyword_list": [
"<string>"
],
"keywords_embedding": {
"embedding": {
"id": "<string>",
"vector": [
123
]
},
"model_used": "<string>"
}
},
"last_written_datetime": "2023-12-25",
"merkle_root": "<string>",
"metadata_index": {
"index": {}
},
"name": "<string>",
"node_count": 1,
"nodes": [
{
"content": {
"Text": "<string>"
},
"data_tag_names": [
"<string>"
],
"id": "<string>",
"last_written_datetime": "2023-12-25",
"merkle_hash": "<string>",
"metadata": {}
}
],
"resource_base_type": "Document",
"resource_embedding": {
"id": "<string>",
"vector": [
123
]
},
"resource_id": "<string>",
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
},
"sfm": {
"map": {},
"source_files_count": 1
},
"version": "V1"
}
}
],
"local_vrpack": [
{
"vrpack": {
"embedding_models_used": {},
"folder_count": 1,
"metadata": {},
"name": "<string>",
"resource": {
"Document": {
"created_datetime": "2023-12-25",
"data_tag_index": {
"index": {}
},
"description": "<string>",
"distribution_info": {
"datetime": "2023-12-25",
"origin": {
"Uri": "<string>"
}
},
"embedding_model_used_string": "<string>",
"embeddings": [
{
"id": "<string>",
"vector": [
123
]
}
],
"keywords": {
"keyword_list": [
"<string>"
],
"keywords_embedding": {
"embedding": {
"id": "<string>",
"vector": [
123
]
},
"model_used": "<string>"
}
},
"last_written_datetime": "2023-12-25",
"merkle_root": "<string>",
"metadata_index": {
"index": {}
},
"name": "<string>",
"node_count": 1,
"nodes": [
{
"content": {
"Text": "<string>"
},
"data_tag_names": [
"<string>"
],
"id": "<string>",
"last_written_datetime": "2023-12-25",
"merkle_hash": "<string>",
"metadata": {}
}
],
"resource_base_type": "Document",
"resource_embedding": {
"id": "<string>",
"vector": [
123
]
},
"resource_id": "<string>",
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
},
"version": "V1",
"vrkai_count": 1
}
}
],
"network_folders": [
{
"external_identity": {
"full_name": "<string>",
"node_name": "<string>",
"profile_name": "<string>",
"subidentity_name": "<string>",
"subidentity_type": "Agent"
},
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
}
}
],
"vector_fs_folders": [
{
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
}
}
],
"vector_fs_items": [
{
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
},
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
]
}
}'
"<any>"
Alter the scope or parameters of an existing job.
Body
application/json
Response
200
application/json
Successfully updated job scope
The response is of type any
.
Was this page helpful?
curl --request POST \
--url http://127.0.0.1:9550/v2/update_job_scope \
--header 'Content-Type: application/json' \
--data '{
"job_id": "<string>",
"job_scope": {
"local_vrkai": [
{
"vrkai": {
"metadata": {},
"resource": {
"Document": {
"created_datetime": "2023-12-25",
"data_tag_index": {
"index": {}
},
"description": "<string>",
"distribution_info": {
"datetime": "2023-12-25",
"origin": {
"Uri": "<string>"
}
},
"embedding_model_used_string": "<string>",
"embeddings": [
{
"id": "<string>",
"vector": [
123
]
}
],
"keywords": {
"keyword_list": [
"<string>"
],
"keywords_embedding": {
"embedding": {
"id": "<string>",
"vector": [
123
]
},
"model_used": "<string>"
}
},
"last_written_datetime": "2023-12-25",
"merkle_root": "<string>",
"metadata_index": {
"index": {}
},
"name": "<string>",
"node_count": 1,
"nodes": [
{
"content": {
"Text": "<string>"
},
"data_tag_names": [
"<string>"
],
"id": "<string>",
"last_written_datetime": "2023-12-25",
"merkle_hash": "<string>",
"metadata": {}
}
],
"resource_base_type": "Document",
"resource_embedding": {
"id": "<string>",
"vector": [
123
]
},
"resource_id": "<string>",
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
},
"sfm": {
"map": {},
"source_files_count": 1
},
"version": "V1"
}
}
],
"local_vrpack": [
{
"vrpack": {
"embedding_models_used": {},
"folder_count": 1,
"metadata": {},
"name": "<string>",
"resource": {
"Document": {
"created_datetime": "2023-12-25",
"data_tag_index": {
"index": {}
},
"description": "<string>",
"distribution_info": {
"datetime": "2023-12-25",
"origin": {
"Uri": "<string>"
}
},
"embedding_model_used_string": "<string>",
"embeddings": [
{
"id": "<string>",
"vector": [
123
]
}
],
"keywords": {
"keyword_list": [
"<string>"
],
"keywords_embedding": {
"embedding": {
"id": "<string>",
"vector": [
123
]
},
"model_used": "<string>"
}
},
"last_written_datetime": "2023-12-25",
"merkle_root": "<string>",
"metadata_index": {
"index": {}
},
"name": "<string>",
"node_count": 1,
"nodes": [
{
"content": {
"Text": "<string>"
},
"data_tag_names": [
"<string>"
],
"id": "<string>",
"last_written_datetime": "2023-12-25",
"merkle_hash": "<string>",
"metadata": {}
}
],
"resource_base_type": "Document",
"resource_embedding": {
"id": "<string>",
"vector": [
123
]
},
"resource_id": "<string>",
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
},
"version": "V1",
"vrkai_count": 1
}
}
],
"network_folders": [
{
"external_identity": {
"full_name": "<string>",
"node_name": "<string>",
"profile_name": "<string>",
"subidentity_name": "<string>",
"subidentity_type": "Agent"
},
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
}
}
],
"vector_fs_folders": [
{
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
}
}
],
"vector_fs_items": [
{
"name": "<string>",
"path": {
"path_ids": [
"<string>"
]
},
"source": {
"Standard": {
"FileRef": {
"file_name": "<string>",
"file_type": {
"Document": "Pdf"
},
"text_chunking_strategy": "V1"
}
}
}
}
]
}
}'
"<any>"
Assistant
Responses are generated using AI and may contain mistakes.