v2

latestOpenAPI 3.1.02026-07-262937191.0 MB

beta.libraries

Create a new Library.

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 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