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
Create Local Wallet
curl --request POST \
--url http://127.0.0.1:9550/v2/create_local_wallet \
--header 'Content-Type: application/json' \
--data '{
"network": "BaseSepolia",
"role": "Payment"
}'{
"address": {
"address_id": "<string>",
"network_id": "BaseSepolia",
"public_key": "<string>",
"wallet_id": "<string>"
},
"id": "<string>",
"network": {
"chain_id": 1,
"display_name": "<string>",
"id": "BaseSepolia",
"is_testnet": true,
"native_asset": {
"asset_id": "<string>",
"contract_address": "<string>",
"decimals": 1,
"network_id": "BaseSepolia"
},
"protocol_family": "Evm"
},
"provider_url": "<string>",
"wallet_private_key": "<string>"
}Generate a new local cryptocurrency wallet within the Shinkai system.
Body
Enum representing the ID of the blockchain network.
BaseSepolia, BaseMainnet, EthereumSepolia, EthereumMainnet, ArbitrumSepolia, ArbitrumMainnet, Anvil Enum to represent different wallet roles. Useful for the API.
Payment, Receiving, Both Response
Represents an address in a wallet.
The onchain address derived on the server-side.
Enum representing the ID of the blockchain network.
BaseSepolia, BaseMainnet, EthereumSepolia, EthereumMainnet, ArbitrumSepolia, ArbitrumMainnet, Anvil The ID of the wallet that owns the address.
The public key from which the address is derived.
Represents a blockchain network.
The chain ID of the blockchain network.
x >= 0The human-readable name of the blockchain network.
Enum representing the ID of the blockchain network.
BaseSepolia, BaseMainnet, EthereumSepolia, EthereumMainnet, ArbitrumSepolia, ArbitrumMainnet, Anvil Whether the network is a testnet or not.
Represents an asset onchain scoped to a particular network.
The ID for the asset on the network.
Enum representing the ID of the blockchain network.
BaseSepolia, BaseMainnet, EthereumSepolia, EthereumMainnet, ArbitrumSepolia, ArbitrumMainnet, Anvil The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.
The number of decimals the asset supports. This is used to convert from atomic units to base units.
x >= 0Enum representing the protocol family of the blockchain network.
Evm Was this page helpful?
curl --request POST \
--url http://127.0.0.1:9550/v2/create_local_wallet \
--header 'Content-Type: application/json' \
--data '{
"network": "BaseSepolia",
"role": "Payment"
}'{
"address": {
"address_id": "<string>",
"network_id": "BaseSepolia",
"public_key": "<string>",
"wallet_id": "<string>"
},
"id": "<string>",
"network": {
"chain_id": 1,
"display_name": "<string>",
"id": "BaseSepolia",
"is_testnet": true,
"native_asset": {
"asset_id": "<string>",
"contract_address": "<string>",
"decimals": 1,
"network_id": "BaseSepolia"
},
"protocol_family": "Evm"
},
"provider_url": "<string>",
"wallet_private_key": "<string>"
}