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
Auth Sync
API Reference
Auth Sync
Creates a new user record or synchronizing an existing account with the authenticated identity from an auth service.
POST
/
v1
/
users
/
self
/
auth-sync
curl --request POST \
--url https://api.storytell.ai/v1/users/self/auth-sync \
--header 'Content-Type: application/json' \
--data '{
"defaultFavoritesCollectionLabel": "<string>",
"defaultOrganizationCollectionLabel": "<string>",
"defaultOrganizationDisplayName": "<string>",
"defaultOrganizationName": "<string>",
"defaultOrganizationSlug": "<string>",
"defaultPersonalCollectionLabel": "<string>",
"defaultProjectDisplayName": "<string>",
"defaultProjectName": "<string>",
"defaultProjectSlug": "<string>",
"deviceID": "<string>",
"displayName": "<string>",
"email": "<string>",
"isEmailVerified": true,
"locale": "<string>",
"photoURL": "<string>",
"userAgent": "<string>",
"workflowVariants": [
"<string>"
]
}'
{
"code": "<string>",
"data": {
"didSignUp": true,
"tokenRefreshReason": "<string>",
"tokenRefreshRequired": true,
"user": {
"address": [
{
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"extendedAddress": "<string>",
"formatted": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"poBox": "<string>",
"postalCode": "<string>",
"region": "<string>",
"streetAddress": "<string>",
"type": "<string>"
}
],
"authDisplayName": "<string>",
"authPictureURL": "<string>",
"displayName": "<string>",
"email": "<string>",
"emails": [
{
"email": "<string>",
"type": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"etag": "<string>",
"externalIdentifiers": [
{
"id": "<string>",
"label": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
}
}
],
"familyName": "<string>",
"givenName": "<string>",
"id": [
127
],
"lifecycleState": "<string>",
"locale": "<string>",
"maintenanceActivities": [
{
"activity": "<string>",
"applied_at": "2023-11-07T05:31:56Z"
}
],
"markedForAbuseAt": "2023-11-07T05:31:56Z",
"markedForAbuseBy": [
127
],
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"markedForAbuseAt": "2023-11-07T05:31:56Z",
"markedForAbuseBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"organizations": [
{
"costCenter": "<string>",
"department": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"occupation": "<string>",
"organizationId": [
127
],
"tenantId": [
127
],
"title": "<string>"
}
],
"phoneticName": "<string>",
"pictureURL": "<string>",
"potentialScore": 123,
"slug": "<string>",
"version": 123
},
"workingContext": {
"CollectionTree": [
{
"children": [
"<any>"
],
"collection": {
"collectionKind": "<string>",
"description": "<string>",
"etag": "<string>",
"icon": "<string>",
"id": [
127
],
"label": "<string>",
"lifecycleState": "<string>",
"organizationId": [
127
],
"path": [
[
127
]
],
"tenantId": [
127
],
"version": 123
}
}
],
"organizationId": [
127
],
"tenantId": [
127
]
}
},
"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/users/self/auth-sync \
--header 'Content-Type: application/json' \
--data '{
"defaultFavoritesCollectionLabel": "<string>",
"defaultOrganizationCollectionLabel": "<string>",
"defaultOrganizationDisplayName": "<string>",
"defaultOrganizationName": "<string>",
"defaultOrganizationSlug": "<string>",
"defaultPersonalCollectionLabel": "<string>",
"defaultProjectDisplayName": "<string>",
"defaultProjectName": "<string>",
"defaultProjectSlug": "<string>",
"deviceID": "<string>",
"displayName": "<string>",
"email": "<string>",
"isEmailVerified": true,
"locale": "<string>",
"photoURL": "<string>",
"userAgent": "<string>",
"workflowVariants": [
"<string>"
]
}'
{
"code": "<string>",
"data": {
"didSignUp": true,
"tokenRefreshReason": "<string>",
"tokenRefreshRequired": true,
"user": {
"address": [
{
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"extendedAddress": "<string>",
"formatted": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"poBox": "<string>",
"postalCode": "<string>",
"region": "<string>",
"streetAddress": "<string>",
"type": "<string>"
}
],
"authDisplayName": "<string>",
"authPictureURL": "<string>",
"displayName": "<string>",
"email": "<string>",
"emails": [
{
"email": "<string>",
"type": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"etag": "<string>",
"externalIdentifiers": [
{
"id": "<string>",
"label": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
}
}
],
"familyName": "<string>",
"givenName": "<string>",
"id": [
127
],
"lifecycleState": "<string>",
"locale": "<string>",
"maintenanceActivities": [
{
"activity": "<string>",
"applied_at": "2023-11-07T05:31:56Z"
}
],
"markedForAbuseAt": "2023-11-07T05:31:56Z",
"markedForAbuseBy": [
127
],
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"markedForAbuseAt": "2023-11-07T05:31:56Z",
"markedForAbuseBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"organizations": [
{
"costCenter": "<string>",
"department": "<string>",
"metadata": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": [
127
],
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": [
127
],
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": [
127
]
},
"occupation": "<string>",
"organizationId": [
127
],
"tenantId": [
127
],
"title": "<string>"
}
],
"phoneticName": "<string>",
"pictureURL": "<string>",
"potentialScore": 123,
"slug": "<string>",
"version": 123
},
"workingContext": {
"CollectionTree": [
{
"children": [
"<any>"
],
"collection": {
"collectionKind": "<string>",
"description": "<string>",
"etag": "<string>",
"icon": "<string>",
"id": [
127
],
"label": "<string>",
"lifecycleState": "<string>",
"organizationId": [
127
],
"path": [
[
127
]
],
"tenantId": [
127
],
"version": 123
}
}
],
"organizationId": [
127
],
"tenantId": [
127
]
}
},
"details": {
"consumption": {
"units": 123
},
"operation": {
"duration": 123,
"operationId": "<string>"
}
},
"done": true,
"eventKey": "<string>",
"message": "<string>"
}