Download OpenAPI specification:Download
Returns the identifiers of all the documents ingested into the Nutrient AI Assistant database.
If the identifier is listed in the response, the database contains contextual information such document metadata, and document contents, as well as AI synthesized information such as classifications, and summaries.
{- "documents": [
- {
- "documentId": "123456789abc",
- "layerName": "myLayer"
}
]
}Deletes the data associated with each layer of the given document, as well as the document default layer (no layer name) itself.
All data including contextual data such as document metadata, and document contents, as well as AI synthesized information such as classifications, and summaries will be deleted.
| documentId required | string Example: 123456789abc The ID of the document to delete. This ID is given when creating the document on the Document Engine. |
{ }Deletes the data associated with the given document layer.
All data including contextual data such as document metadata, and document contents, as well as AI synthesized information such as classifications, and summaries will be deleted.
| documentId required | string Example: 123456789abc The ID of the document to delete the layer from. This ID is given when creating the document on the Document Engine. |
| layerName required | string Example: 123456789abc The name of the layer to delete. This layer name is given when creating a layer on the Document Engine. |
{ }Checks if a document with the given ID and file hash has already been ingested into the Nutrient AI Assistant database.
| documentId required | string The permanent ID of the document to check if it is ingested. This ID uniquely identifies a document and won't change if the document is modified. |
| fileHash required | string The hash of the file in its current state. |
{ }Ingests a PDF document directly into the Nutrient AI Assistant database. The document will be processed, analyzed, and stored for future retrieval and analysis.
The endpoint expects a raw PDF file in the request body with content-type application/pdf.
Returns permanent and changing IDs for the document.
| file required | string <binary> |
{- "permanentId": "string",
- "changingId": "string",
- "token": "string"
}Ingests a PDF document stored in Nutrient Document Engine into the Nutrient AI Assistant database. The document will be processed, analyzed, and stored for future retrieval and analysis.
| documentId required | string Example: 123456789abc The ID of the document to ingest. This ID is given when creating the document on the Document Engine. |
| fileHash required | string Example: 123456789abc The hash of the file in its current state. This will be used to check if the file has changed since the last ingest and whether to trigger a new ingest. |
{ }Ingests a PDF document stored in Nutrient Document Engine into the Nutrient AI Assistant database. The document will be processed, analyzed, and stored for future retrieval and analysis.
| documentId required | string Example: 123456789abc The ID of the document to ingest. This ID is given when creating the document on the Document Engine. |
| layerName required | string Example: myLayer The optional name of the layer to ingest. This layer name is given when creating a layer on the Document Engine. |
| fileHash required | string Example: 123456789abc The hash of the file in its current state. This will be used to check if the file has changed since the last ingest and whether to trigger a new ingest. |
{ }Returns all the session information held in the AI Assistant database.
This includes the session ID, the user ID (if present), and the timestamp of the last message sent.
{- "sessions": [
- {
- "sessionId": "123456789abc",
- "timestamp": 1620000000000,
- "userId": "123456789abc"
}
]
}Deletes all session data for the given Session ID.
This includes all messages and metadata associated with the session. Meaning the chat history will no longer be available.
| sessionId required | string Example: 123456789abc The unique identifier for the session. This value is given as part of the AI Assistant configuration when initializing the Nutrient Web SDK. |
{ }Returns all the session information for all sessions tagged with a given user ID.
Sessions are tagged with a user ID when the AI Assistant configuration in the Nutrient Web SDK is initialized with a user ID.
| userId required | string Example: 123456789abc The unique identifier for the user. This value is optionally given in the AI Assistant configuration when initializing the Nutrient Web SDK. |
{- "sessions": [
- {
- "sessionId": "123456789abc",
- "timestamp": 1620000000000,
- "userId": "123456789abc"
}
]
}