Skip to main content
Server path: /mistral-libraries | Type: Application | PCID required: Yes

Tools

ToolDescription
mistral_libraries_create_v1Create a new Library.
mistral_libraries_delete_v1Delete a library and all of it’s document.
mistral_libraries_documents_delete_v1Delete a document.
mistral_libraries_documents_get_extracted_text_signed_url_v1Retrieve the signed URL of text extracted from a given document.
mistral_libraries_documents_get_signed_url_v1Retrieve the signed URL of a specific document.
mistral_libraries_documents_get_status_v1Retrieve the processing status of a specific document.
mistral_libraries_documents_get_text_content_v1Retrieve the text content of a specific document.
mistral_libraries_documents_get_v1Retrieve the metadata of a specific document.
mistral_libraries_documents_list_v1List documents in a given library.
mistral_libraries_documents_reprocess_v1Reprocess a document.
mistral_libraries_documents_update_v1Update the metadata of a specific document.
mistral_libraries_documents_upload_v1Upload a new document.
mistral_libraries_get_v1Detailed information about a specific Library.
mistral_libraries_list_v1List all libraries you have access to.
mistral_libraries_share_create_v1Create or update an access level.
mistral_libraries_share_delete_v1Delete an access level.
mistral_libraries_share_list_v1List all of the access to this library.
mistral_libraries_update_v1Update a library.

mistral_libraries_create_v1

Create a new Library. Parameters:
ParameterTypeRequiredDefaultDescription
chunk_sizeintegerNoChunk Size
descriptionstringNoThe description value
namestringYesThe name value

mistral_libraries_delete_v1

Delete a library and all of it’s document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id

mistral_libraries_documents_delete_v1

Delete a document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_get_extracted_text_signed_url_v1

Retrieve the signed URL of text extracted from a given document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_get_signed_url_v1

Retrieve the signed URL of a specific document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_get_status_v1

Retrieve the processing status of a specific document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_get_text_content_v1

Retrieve the text content of a specific document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_get_v1

Retrieve the metadata of a specific document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_list_v1

List documents in a given library. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
searchstringNoThe search value
page_sizeintegerNoNumber of results per page
pageintegerNoPage number for pagination
filters_attributesstringNoFilters Attributes
sort_bystringNoSort By
sort_orderstringNoSort Order

mistral_libraries_documents_reprocess_v1

Reprocess a document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id

mistral_libraries_documents_update_v1

Update the metadata of a specific document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
document_idstringYesDocument Id
attributesobjectNoThe attributes value
namestringNoThe name value

mistral_libraries_documents_upload_v1

Upload a new document. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
filestringYesThe File object (not file name) to be uploaded. To upload a file and specify a custom file name you should format your request as such: bash file=@path/to/your/file.jsonl;filename=custom_name.jsonl Otherwise, you can just keep the original file name: bash file=@path/to/your/file.jsonl

mistral_libraries_get_v1

Detailed information about a specific Library. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id

mistral_libraries_list_v1

List all libraries you have access to.

mistral_libraries_share_create_v1

Create or update an access level. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
levelstringYesThe level value
org_idstringNoOrg Id
share_with_typestringYesThe type of entity, used to share a library.
share_with_uuidstringYesThe id of the entity (user, workspace or organization) to share with

mistral_libraries_share_delete_v1

Delete an access level. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
org_idstringNoOrg Id
share_with_typestringYesThe type of entity, used to share a library.
share_with_uuidstringYesThe id of the entity (user, workspace or organization) to share with

mistral_libraries_share_list_v1

List all of the access to this library. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id

mistral_libraries_update_v1

Update a library. Parameters:
ParameterTypeRequiredDefaultDescription
library_idstringYesLibrary Id
descriptionstringNoThe description value
namestringNoThe name value