POST
/
v1
/
resource
/
website

Authorizations

x-api-key
string
header
required

Body

application/json

An array of sub-URLs to include under the website URL.

syncFrequency
string[]
required

An enum of the sync frequency. Values can be ONE_DAY | THREE_DAYS | SEVEN_DAYS | ONE_MONTH | NEVER.

url
string
required

The website URL.

Response

201 - application/json
aiProcessingStatus
string
required

The status of the AI processing of the resource. Values can be NOT_STARTED | IN_PROGRESS | DONE | FAILED_NO_TEXT_FOUND | FAILED.

createdAt
number
required

The created date of the resource. Unix timestamp in milliseconds.

creator
string
required

The user id of the creator.

fileName
string
required

The name of the resource.

id
string
required

The resource's id.

organisation
string
required

The organisation id of the resource.

type
string
required

The type of the resource. Values can be VIDEO | PDF | TEXT | YOUTUBE | WEB | GOOGLE_DRIVE.

fileSize
number

File length in bytes. Defined only of the resource type is PDF or VIDEO.

googleDriveResourceFile
object

Google Drive resource object. Defined only of the resource type is GOOGLE_DRIVE.

lastSync
number

Last synchronization date. Unix timestamp in milliseconds.

syncFrequencyMs
number

Synchronization frequency in milliseconds.

videoLength
number

Video length in seconds. Defined only of the resource type is VIDEO.

website
object

Website data. Defined only of the resource type is WEB.

youtubeVideoId
number

YouTube video id. Defined only of the resource type is YOUTUBE.