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
Search Assets by Name
API Reference
Search Assets by Name
Finds and returns assets that match the provided name search criteria.
POST
/
v1
/
assets
/
search
curl --request POST \
--url https://api.storytell.ai/v1/assets/search \
--header 'Content-Type: application/json' \
--data '{
"filterByCollections": [
[
127
]
],
"filterByContentType": [
"<string>"
],
"lifecycleStates": [
"<string>"
],
"matchName": "<string>",
"pagination": {
"Limit": 1,
"Offset": 1,
"Sort": [
"<string>"
]
}
}'
{
"code": "<string>",
"data": {
"pagination": {
"count": 1,
"currentPage": 1,
"firstRecordOnPage": "<string>",
"hasNextPage": true,
"hasPreviousPage": true,
"lastRecordOnPage": "<string>",
"limit": 1,
"offset": 1,
"totalPages": 1
},
"result": {
"collections": {},
"entities": [
{
"actions": [
"<string>"
],
"collectionIds": [
[
127
]
],
"data": {
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"etag": "<string>",
"filesize": 123,
"id": "<string>",
"lifecycleState": "<string>",
"modifiedAt": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"originalFilename": "<string>",
"processingFailureReason": "<string>",
"processingStatusText": "<string>",
"signedSourceURL": "<string>",
"summary": "<string>",
"tenantId": "<string>",
"textTokens": 123,
"userDisplayName": "<string>",
"userId": "<string>",
"version": -1
},
"flags": [
[
"<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
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
Required range:
x > 0
access the source asset for up to 12 hours.
Required range:
-2147483648 < x < 2147483647
curl --request POST \
--url https://api.storytell.ai/v1/assets/search \
--header 'Content-Type: application/json' \
--data '{
"filterByCollections": [
[
127
]
],
"filterByContentType": [
"<string>"
],
"lifecycleStates": [
"<string>"
],
"matchName": "<string>",
"pagination": {
"Limit": 1,
"Offset": 1,
"Sort": [
"<string>"
]
}
}'
{
"code": "<string>",
"data": {
"pagination": {
"count": 1,
"currentPage": 1,
"firstRecordOnPage": "<string>",
"hasNextPage": true,
"hasPreviousPage": true,
"lastRecordOnPage": "<string>",
"limit": 1,
"offset": 1,
"totalPages": 1
},
"result": {
"collections": {},
"entities": [
{
"actions": [
"<string>"
],
"collectionIds": [
[
127
]
],
"data": {
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"etag": "<string>",
"filesize": 123,
"id": "<string>",
"lifecycleState": "<string>",
"modifiedAt": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"originalFilename": "<string>",
"processingFailureReason": "<string>",
"processingStatusText": "<string>",
"signedSourceURL": "<string>",
"summary": "<string>",
"tenantId": "<string>",
"textTokens": 123,
"userDisplayName": "<string>",
"userId": "<string>",
"version": -1
},
"flags": [
[
"<string>"
]
]
}
]
}
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}