UHuhh-lt
sourceDocument

Updates the SourceDocument with the given ID.

Changed on
patch/sdoc/{sdoc_id}

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Path parameters

sdoc_idinteger required

Request body

namestring nullable

User-defined name of the document (default is the filename)

folder_idinteger nullable

ID of the Folder this SourceDocument belongs to

extract_html-100 | 0 | 1
text_extraction-100 | 0 | 1
text_language_detection-100 | 0 | 1
text_spacy-100 | 0 | 1
text_es_index-100 | 0 | 1
text_sentence_embedding-100 | 0 | 1
text_html_mapping-100 | 0 | 1
image_caption-100 | 0 | 1
image_embedding-100 | 0 | 1
image_metadata_extraction-100 | 0 | 1
image_thumbnail-100 | 0 | 1
image_object_detection-100 | 0 | 1
audio_metadata-100 | 0 | 1
audio_thumbnail-100 | 0 | 1
audio_transcription-100 | 0 | 1
video_metadata-100 | 0 | 1
video_thumbnail-100 | 0 | 1
video_audio_extraction-100 | 0 | 1

Response

Successful Response

filenamestring required

Filename of the SourceDocument

namestring required

User-defined name of the document (default is the filename)

doctype'text' | 'image' | 'video' | 'audio' required
project_idinteger required

Project the SourceDocument belongs to

idinteger required

ID of the SourceDocument

createdstring date-time required

The created timestamp of the SourceDocument

updatedstring date-time required

Updated timestamp of the SourceDocument

folder_idinteger required

ID of the Folder this SourceDocument belongs to

memo_idsinteger[]

IDs of the Memos attached to the SourceDocument

Changes