General
Initial Registration
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
General
Initial Registration
POST
/
v2
/
initial_registration
curl --request POST \
--url http://127.0.0.1:9550/v2/initial_registration \
--header 'Content-Type: application/json' \
--data '{
"body": {
"encrypted": {
"content": "<string>"
}
},
"encryption": "DiffieHellmanChaChaPoly1305",
"external_metadata": {
"intra_sender": "<string>",
"other": "<string>",
"recipient": "<string>",
"scheduled_time": "<string>",
"sender": "<string>",
"signature": "<string>"
},
"version": "V1_0"
}'
{
"api_v2_key": "<string>",
"encryption_public_key": "<string>",
"identity_public_key": "<string>",
"message": "<string>",
"node_name": "<string>"
}
Register a new user or device with the Shinkai API for the first time.
Body
application/json
Response
200
application/json
Successfully used registration code
The response is of type object
.
Was this page helpful?
curl --request POST \
--url http://127.0.0.1:9550/v2/initial_registration \
--header 'Content-Type: application/json' \
--data '{
"body": {
"encrypted": {
"content": "<string>"
}
},
"encryption": "DiffieHellmanChaChaPoly1305",
"external_metadata": {
"intra_sender": "<string>",
"other": "<string>",
"recipient": "<string>",
"scheduled_time": "<string>",
"sender": "<string>",
"signature": "<string>"
},
"version": "V1_0"
}'
{
"api_v2_key": "<string>",
"encryption_public_key": "<string>",
"identity_public_key": "<string>",
"message": "<string>",
"node_name": "<string>"
}