MImistral
beta.libraries.documents

Update the metadata of a specific document.

Changed on

Given a library and a document in that library, update the name of that document.

put/v1/libraries/{library_id}/documents/{document_id}

Request

Path parameters

library_idstring uuid required
document_idstring uuid required

Request body

namestring
attributesobject nullable
expires_atstring date-time nullable

If set, the document will be automatically deleted after this date.

Response

Successful Response

idstring uuid required
library_idstring uuid required
hashstring nullable required
mime_typestring nullable required
extensionstring nullable required
sizeinteger nullable required
namestring required
summarystring nullable
created_atstring date-time required
last_processed_atstring date-time nullable
number_of_pagesinteger nullable
process_status'self_managed' | 'missing_content' | 'noop' | 'done' | 'todo' | 'in_progress' | 'error' | 'waiting_for_capacity' required
uploaded_by_idstring uuid nullable required
uploaded_by_typestring required
tokens_processing_main_contentinteger nullable
tokens_processing_summaryinteger nullable
urlstring nullable
attributesobject nullable
expires_atstring date-time nullable

If set, the document will be automatically deleted after this date.

processing_statusstring required
tokens_processing_totalinteger required

Changes

  • 5a5c361558bbRevision changes
    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • info

      endpoint deprecated

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      response property hash deprecated

    • info

      response property processing_status deprecated

    • info

      response property tokens_processing_main_content deprecated

    • info

      response property tokens_processing_summary deprecated

  • ff8a7389b7a4Revision changes
    • info

      endpoint added