Knowledge Base

PATCH /kb/sources/{id}

PATCH operation for /kb/sources/{id}

patch/kb/sources/{id}

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/kb/sources/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Request body

idinteger
collectionstring
namestring required
source_type'url' | 'pdf' | 'docx' | 'txt' required
source_valuestring required
source_filestring binary
file_size_bytesinteger
status'ready' | 'processing' | 'failed'
refresh_schedule'manual' | 'daily' | 'weekly' | 'monthly'
last_refreshedstring date-time
summarystring
extracted_textstring
created_atstring date-time
modified_atstring date-time

Response

Successful response

idinteger
collectionstring
namestring required
source_type'url' | 'pdf' | 'docx' | 'txt' required
source_valuestring required
source_filestring binary
file_size_bytesinteger
status'ready' | 'processing' | 'failed'
refresh_schedule'manual' | 'daily' | 'weekly' | 'monthly'
last_refreshedstring date-time
summarystring
extracted_textstring
created_atstring date-time
modified_atstring date-time

Changes

No recorded changes to this operation across all 3 revisions of this API.