List documents

GET

/api/v1/documents

const url = 'http://localhost:11044/api/v1/documents';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/documents \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns the current world context’s ingested documents with metadata, plus the total chunk count.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of documents

*/*

The current world context’s ingested documents

object

documents

required

The documents, in the order they were tracked

Array<object>

One ingested document, as the listing describes it

object

chunks

required

How many chunks the document was split into

integer format: int32

chunksWithoutEmbeddings

required

How many of those chunks have no embedding, and so miss semantic search

integer format: int32

createdAt

When the source was created, ISO-8601, where the ingest captured it

string

ingestedAt

When this server ingested it, ISO-8601

string

modifiedAt

When the SOURCE last changed, ISO-8601, where the ingest captured it. Null also means it was ingested before source dates were captured — itself a reason to re-read it

string

tags

required

The document’s tags. Empty when it has none

Array<string>

title

The document’s title, null where none was found

string

uri

required

The document’s URI, which delete, retag and ask take

string

totalChunks

required

Every chunk stored for this world context, across all its documents

integer format: int32