MImistral
beta.libraries

Create a new Library.

Changed on

Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you.

post/v1/libraries

Request

Request body

namestring required
descriptionstring nullable
chunk_sizeinteger nullable

The size of the chunks (in characters) to split document text into. Must be between 256 and 32768.

owner_type'User' | 'Workspace' nullable

Determines who owns the created library. 'User' creates a private library accessible only to its owner. 'Workspace' creates a library shared with the workspace. Defaults to 'Workspace' for API key sessions. Only API keys with the 'Private and shared connectors' connector access scope can create private, user-owned libraries.

Response

Successful Response

idstring uuid required
namestring required
created_atstring date-time required
updated_atstring date-time required
owner_idstring uuid nullable required
owner_typestring required
total_sizeinteger required
nb_documentsinteger required
chunk_sizeinteger nullable required
emojistring nullable
descriptionstring nullable
generated_descriptionstring nullable
explicit_user_members_countinteger nullable
explicit_workspace_members_countinteger nullable
org_sharing_rolestring nullable
generated_namestring nullable

Generated Name

Changes

  • 5a5c361558bbRevision changes
    • warning

      the / request property's max was set to 32768.00

    • warning

      the / request property's min was set to 256.00

    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      response property chunk_size deprecated

    • info

      response property emoji deprecated

    • info

      response property explicit_user_members_count deprecated

    • info

      response property explicit_workspace_members_count deprecated

    • info

      response property generated_description deprecated

    • info

      response property generated_name deprecated

    • info

      response property org_sharing_role deprecated

  • ff8a7389b7a4Revision changes
    • info

      endpoint added