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
Crawl URL
API Reference
Crawl URL
Crawls a URL and creates an asset for the content suitable for chat.
POST
/
v1
/
url
/
crawl
curl --request POST \
--url https://api.storytell.ai/v1/url/crawl \
--header 'Content-Type: application/json' \
--data '{
"collectionID": [
127
],
"organizationID": [
127
],
"processInBackground": true,
"processInThread": true,
"tenantID": [
127
],
"url": "<string>"
}'
{
"code": "<string>",
"data": {
"chunkingStrategy": "<string>",
"collectionIds": [
[
127
]
],
"contentType": "<string>",
"displayName": "<string>",
"embeddings": [
{
"model": "<string>",
"state": "<string>"
}
],
"etag": "<string>",
"extractionStrategy": "<string>",
"failureReason": "<string>",
"fileSize": 123,
"htmlArtifactTokenCount": 123,
"id": [
127
],
"keywordStrategy": "<string>",
"keywords": [
"<string>"
],
"keywordsTokenCount": 123,
"lifecycleState": "<string>",
"lifecyclesCompleted": [
"<string>"
],
"markdownTokenCount": 123,
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"embeddings": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"extract": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"lastReadyAt": "2023-11-07T05:31:56Z",
"lastReferencedAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
],
"processing": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"summarize": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"transcribe": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"uploadedAt": "2023-11-07T05:31:56Z"
},
"organizationId": [
127
],
"originalFileName": "<string>",
"processingErrMessage": "<string>",
"processingMessage": "<string>",
"producedEmbeddings": true,
"producedHTMLArtifact": true,
"producedKeywords": true,
"producedMarkdownArtifact": true,
"producedSummary": true,
"producedTranscriptionArtifact": true,
"references": [
{
"referenceId": [
127
],
"referencedAt": "2023-11-07T05:31:56Z",
"referencedBy": [
127
],
"referencedFor": [
127
],
"vendor": "<string>",
"vendorIdentifier": "<string>"
}
],
"signedURL": "<string>",
"summary": "<string>",
"summaryStrategy": "<string>",
"summaryTokenCount": 123,
"tenantId": [
127
],
"textTokens": 123,
"transcriptionTokenCount": 123,
"version": 123,
"workerStrategy": "<string>"
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}
Body
application/json
Response
200
application/json
Success response
The response is of type object
.
curl --request POST \
--url https://api.storytell.ai/v1/url/crawl \
--header 'Content-Type: application/json' \
--data '{
"collectionID": [
127
],
"organizationID": [
127
],
"processInBackground": true,
"processInThread": true,
"tenantID": [
127
],
"url": "<string>"
}'
{
"code": "<string>",
"data": {
"chunkingStrategy": "<string>",
"collectionIds": [
[
127
]
],
"contentType": "<string>",
"displayName": "<string>",
"embeddings": [
{
"model": "<string>",
"state": "<string>"
}
],
"etag": "<string>",
"extractionStrategy": "<string>",
"failureReason": "<string>",
"fileSize": 123,
"htmlArtifactTokenCount": 123,
"id": [
127
],
"keywordStrategy": "<string>",
"keywords": [
"<string>"
],
"keywordsTokenCount": 123,
"lifecycleState": "<string>",
"lifecyclesCompleted": [
"<string>"
],
"markdownTokenCount": 123,
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"embeddings": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"extract": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"lastReadyAt": "2023-11-07T05:31:56Z",
"lastReferencedAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
],
"processing": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"summarize": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"transcribe": {
"completedAt": "2023-11-07T05:31:56Z",
"count": 123,
"failedAt": "2023-11-07T05:31:56Z",
"failedReason": "<string>",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"statusCode": 123,
"step": "<string>"
},
"uploadedAt": "2023-11-07T05:31:56Z"
},
"organizationId": [
127
],
"originalFileName": "<string>",
"processingErrMessage": "<string>",
"processingMessage": "<string>",
"producedEmbeddings": true,
"producedHTMLArtifact": true,
"producedKeywords": true,
"producedMarkdownArtifact": true,
"producedSummary": true,
"producedTranscriptionArtifact": true,
"references": [
{
"referenceId": [
127
],
"referencedAt": "2023-11-07T05:31:56Z",
"referencedBy": [
127
],
"referencedFor": [
127
],
"vendor": "<string>",
"vendorIdentifier": "<string>"
}
],
"signedURL": "<string>",
"summary": "<string>",
"summaryStrategy": "<string>",
"summaryTokenCount": 123,
"tenantId": [
127
],
"textTokens": 123,
"transcriptionTokenCount": 123,
"version": 123,
"workerStrategy": "<string>"
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}