Upload Document Contents
Headers
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Request
The full LLM-formatted text contents of the document you want to upload.
[Legacy] The user on behalf of whom the document should be uploaded. In most cases, this can simply be the email of the developer making the API call. This field will be removed in the future in favor of purely specifying permissions via allowedUsersEmailAddresses.
If specified, the document will also be added to the provided document collection. This operation is eventually consistent, meaning the document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To achieve strong consistency use the awaitVectorStoreSync
parameter.
If specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal
Document uploads are eventually consistent by default. If specified true
the API will wait for the vector store to be updated before returning. This is useful if you want to ensure that the document is immediately searchable after this call returns.