archives

Create Passage In Archive

Create a new passage in an archive. This adds a passage to the archive and creates embeddings for vector storage.

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path Parameters

archive_idstringRequiredformat: "^archive-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=44 characters

The ID of the archive in the format ‘archive-<uuid4>’

Request

This endpoint expects an object.
textstringRequired
The text content of the passage
metadatamap from strings to any or nullOptional
Optional metadata for the passage
tagslist of strings or nullOptional
Optional tags for categorizing the passage

Response

Successful Response
textstring
The text of the passage.
embeddinglist of doubles or null
The embedding of the passage.
embedding_configobject or null
The embedding configuration used by the passage.
created_by_idstring or null
The id of the user that made this object.
last_updated_by_idstring or null
The id of the user that made this object.
created_atstring or nullformat: "date-time"
The creation date of the passage.
updated_atstring or nullformat: "date-time"
The timestamp when the object was last updated.
is_deletedboolean or nullDefaults to false
Whether this passage is deleted or not.
archive_idstring or null
The unique identifier of the archive containing this passage.
source_idstring or null
The data source of the passage.
file_idstring or null
The unique identifier of the file associated with the passage.
file_namestring or null

The name of the file (only for source passages).

metadatamap from strings to any or null
The metadata of the passage.
tagslist of strings or null
Tags associated with this passage.
idstring or nullformat: "^passage-[a-fA-F0-9]{8}"

The human-friendly ID of the Passage

Errors