Returns a fact by UUID

Delete a fact for the given UUID

Add a session

Get all sessions with optional page number, page size, order by field and order direction for pagination.

Page number for pagination, starting from 1

Order direction: true for ascending, false for descending

Returns all sessions in a specified order

End multiple sessions. (cloud only)

The maximum number of search results to return. Defaults to None (no limit).

Search sessions for the specified query.

Returns a session by ID

Update a session

Classify a session (cloud only)

End a session (cloud only)

Minimum rating by which to filter facts (Zep Cloud only)

Returns all facts for a session by ID (cloud only)

Adds facts to a session (cloud only)

Returns a memory (latest summary, list of messages and facts) for a given session

The ID of the session for which to retrieve memory.

The number of most recent memory entries to retrieve.

The minimum rating by which to filter facts

Get session memory

The ID of the session to which memory should be added.

Add memory to the specified session.

The ID of the session for which memory should be deleted.

Delete memory messages for a given session

Lists messages for a session, specified by limit and cursor.

Lists messages for a session

Gets a specific message from a session

Updates the metadata of a message.

The ID of the session for which memory should be searched.

Search memory for the specified session (cloud only)

Returns a session's summaries by ID (cloud only)

Synthesize a question from the last N messages in the chat history.

The number of messages to use for question synthesis.

Synthesize a question (cloud only)

Memory

Add a user.

List all users

Get a user.

Delete a user

Update a user.

List all sessions for a user

User

Returns a list of all DocumentCollections.

Gets a list of DocumentCollections (cloud only)

Returns a DocumentCollection if it exists.

Gets a DocumentCollection (cloud only)

If a collection with the same name already exists, an error will be returned.

Creates a new DocumentCollection

If a collection with the same name already exists, it will be overwritten.

Deletes a DocumentCollection

Updates a DocumentCollection

Creates Documents in a specified DocumentCollection and returns their UUIDs.

Creates Multiple Documents in a DocumentCollection (cloud only)

Deletes specified Documents from a DocumentCollection.

Batch Deletes Documents from a DocumentCollection by UUID (cloud only)

Returns Documents from a DocumentCollection specified by UUID or ID.

Batch Gets Documents from a DocumentCollection (cloud only)

Updates Documents in a specified DocumentCollection.

Batch Updates Documents in a DocumentCollection (cloud only)

Returns specified Document from a DocumentCollection.

Gets a Document from a DocumentCollection by UUID (cloud only)

Delete specified Document from a DocumentCollection.

Delete Document from a DocumentCollection by UUID (cloud only)

Updates a Document in a DocumentCollection by UUID

Updates a Document (cloud only)

Searches over documents in a collection based on provided search criteria. One of text or metadata must be provided. Returns an empty list if no documents are found.

Searches Documents in a DocumentCollection (cloud only)

Document

APIError

ApidataDocument

ApidataDocumentCollection

ApidataDocumentSearchResponse

ApidataDocumentWithScore

ClassifySessionRequest

Custom instruction to use for classification.

The number of session messages to consider for classification. Defaults to 4.

The name of the classifier. Will be used to store the classification in session metadata if persist is True.

Whether to persist the classification to session metadata. Defaults to True.

CreateDocumentRequest

EndSessionResponse

EndSessionsResponse

Fact

FactRatingExamples

FactRatingInstruction

Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
based on relevance to a trip planning application, your examples might be:
High: "Joe's dream vacation is Bali"
Medium: "Joe has a fear of flying",
Low: "Joe's favorite food is Japanese",

A string describing how to rate facts as they apply to your application. A trip planning application may
use something like "relevancy to planning a trip, the user's preferences when traveling,
or the user's travel history."

FactResponse

FactsResponse

A dictionary containing metadata associated with the memory.

Most relevant facts to the recent messages in the session.

The most recent summary before last nth message. (cloud only)

MemorySearchResult

Message

The timestamp of when the message was created.

The metadata associated with the message.

The role of the sender of the message (e.g., "user", "assistant").

The type of the role (e.g., "user", "system").

The timestamp of when the message was last updated.

MessageListResponse

NewFact

Question

RoleType

SearchScope

SearchType

Session

Must be a pointer to allow for null values

SessionClassification

SessionFactRatingExamples

SessionFactRatingInstruction

SessionListResponse

SessionSearchResponse

SessionSearchResult

SuccessResponse

Summary

The timestamp of when the summary was created.

1	curl -X PATCH https://api.getzep.com/api/v2/collections/collectionName/documents/uuid/documentUUID \
2	-H "Authorization: Api-Key <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

Updates a Document (cloud only)

Path parameters

Request

Response

Errors