Knowledge

create knowledge group

Changed on

Create a new knowledge group

post/v1/knowledge/groups

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/knowledge/groups
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring
chunkSizeinteger nullable

Default maximum tokens per chunk for documents processed in this group. When not set or null, the group stores the default of 350.

chunkOverlapinteger nullable

Default token overlap for documents processed in this group. Must be at most half of chunkSize, or at most 175 when chunkSize is not set. When not set or null, the group stores the default of 0.

Response

Successfully created knowledge group

idstring uuid

Unique identifier for the knowledge group.

namestring

Human-readable name for the group.

descriptionstring nullable

Free-form description of what the group contains.

documentCountinteger

Number of non-deleted documents currently in the group.

chunkSizeinteger nullable

Default maximum tokens per chunk for documents in this group. Null means documents use the default of 350.

chunkOverlapinteger nullable

Default token overlap for documents in this group. Null means documents use the default of 0.

createdAtstring date-time

Timestamp when the group was created.

updatedAtstring date-time nullable

Timestamp when the group was last updated.

Changes

    • info

      added the non-success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status