API documentation
API Reference
- GETHeal Missing User Snapshots
- POSTHeal Missing User Snapshots
- GETRepair Missing User Data
- GETHealth Check
- POSTGenerate Placeholder IDs
- GETPlaceholder Struct for Server Generation
- GETPlaceholder Struct for Thread Content Types
- POSTUpdate Asset Processing State
- POSTUpdate Asset Properties
- POSTInitialize New Asset Upload
- POSTRegister Uploaded Asset
- POSTSearch Assets by Name
- DELDelete Assets (Recoverable)
- GETGet Asset Details
- GETRedeem Access Token
- GETList Collection Members and Pending Invites
- DELDelete Invitation Token
- GETList Collection Assets
- POSTUpdate Collection Properties
- POSTMove Collection and Descendants
- GETList Collection Threads
- POSTAdd New Collection
- DELPermanently Delete Collections
- GETView Collection Details
- POSTLink Assets to Collection
- POSTLink Threads to Collection
- POSTCreate New Device Identifier
- GETGenerate Admin Diagnostic URL
- POSTUpload User Feedback Diagnostics
- POSTUpdate Collection Access Rights
- GETGet User's Recent Assets
- GETList User's Recent Threads
- POSTEnhance Prompt
- POSTShare Collection With Others
- POSTCreate Organization Thread
- DELDelete Threads (Recoverable)
- GETGet Thread Details
- POSTUpdate Thread Properties
- POSTProcess Thread Message
- POSTShare Thread with Link or Email
- POSTCrawl URL
- PUTMerge User Accounts
- POSTAuth Sync
- GETView Collection Hierarchy
- GETHandle WebSocket Connection
- GETFallback is called for debug endpoints. Not intended for normal use.
- PUTFallback is called for debug endpoints. Not intended for normal use.
- POSTFallback is called for debug endpoints. Not intended for normal use.
- DELFallback is called for debug endpoints. Not intended for normal use.
- HEADFallback is called for debug endpoints. Not intended for normal use.
- PATCHFallback is called for debug endpoints. Not intended for normal use.
API Reference
Health Check
API Reference
Health Check
Returns the status of the service.
GET
/
status
curl --request GET \
--url https://api.storytell.ai/status
{
"code": "<string>",
"data": {
"alloc": 1,
"fileproc": {
"bornAt": "2023-11-07T05:31:56Z",
"goRoutines": 123,
"memory": {
"rss": "<string>",
"vms": "<string>"
},
"status": "<string>"
},
"fileprocStatusCheckLatencyMS": 123,
"go_version": "<string>",
"heap_alloc": 1,
"heap_idle": 1,
"heap_inuse": 1,
"heap_sys": 1,
"last_gc": "2023-11-07T05:31:56Z",
"num_cpu": 123,
"num_gc": 2147483647,
"num_goroutine": 123,
"pause_total_ns": 1,
"stack_inuse": 1,
"start_time": "2023-11-07T05:31:56Z",
"sys": 1,
"total_alloc": 1,
"uptime": "<string>"
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}
Response
200
application/json
Success response
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
0 < x < 4294967295
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
curl --request GET \
--url https://api.storytell.ai/status
{
"code": "<string>",
"data": {
"alloc": 1,
"fileproc": {
"bornAt": "2023-11-07T05:31:56Z",
"goRoutines": 123,
"memory": {
"rss": "<string>",
"vms": "<string>"
},
"status": "<string>"
},
"fileprocStatusCheckLatencyMS": 123,
"go_version": "<string>",
"heap_alloc": 1,
"heap_idle": 1,
"heap_inuse": 1,
"heap_sys": 1,
"last_gc": "2023-11-07T05:31:56Z",
"num_cpu": 123,
"num_gc": 2147483647,
"num_goroutine": 123,
"pause_total_ns": 1,
"stack_inuse": 1,
"start_time": "2023-11-07T05:31:56Z",
"sys": 1,
"total_alloc": 1,
"uptime": "<string>"
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}