Sign in
Documents

Get document

Retrieves one source document from the project's Datasphere knowledge store by ID. Use it to check a known document and its readiness for retrieval; use List documents to discover IDs or Search documents to find relevant passages.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.

Learn more about API scopes.

get/api/datasphere/documents/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Document.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

filenamestring required

Name of the Document.

status'submitted' | 'in_progress' | 'completed' | 'failed' required

The current Status of the Document.

tagsstring[] required

Document tags.

chunking_strategy'sentence' | 'paragraph' | 'page' | 'sliding' required

Strategy to use when chunking the document.

max_sentences_per_chunkinteger nullable required

Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.

split_newlinesboolean nullable required

Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.

overlap_sizeinteger nullable required

Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.

chunk_sizeinteger nullable required

Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.

number_of_chunksinteger required

Number of Chunks in the Document.

chunks_uristring required

URI path to the chunks for this document.

created_atstring date-time required

Document Creation Date.

updated_atstring date-time required

Document Update Date.

Example response

{
  "filename": "player_list.pdf",
  "tags": [
    "sports",
    "football",
    "game"
  ],
  "max_sentences_per_chunk": 80,
  "split_newlines": true,
  "overlap_size": 10,
  "chunk_size": 50,
  "number_of_chunks": 2345,
  "chunks_uri": "/api/rest/datasphere/documents/acaa5c49-be5e-4477-bce0-48f4b23b7720/chunks",
  "created_at": "2024-05-06T12:20-12Z",
  "updated_at": "2024-05-06T12:20-12Z"
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.