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
​
collectionID
integer[]
required
​
organizationID
integer[]
required
​
processInBackground
boolean
required

processed in the background. If false, the trigger to process the asset must occur through the threads domain as knowledge is added. Otherwise, the system will begin processing async in the background.

​
processInThread
boolean
required

processed through a websocket message.

​
tenantID
integer[]
required
​
url
string
required

Response

200
application/json
Success response
​
code
string
required
​
data
object
required
​
details
object
required
​
done
boolean
required
​
eventKey
string
required
​
message
string
required

Was this page helpful?

Previous
Merge User Accounts
Next