Get a Document

View as Markdown

Retrieves a Datasphere Document by ID.

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Document.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Document.
filenamestring
Name of the Document.
statusenum
Status of the Document.
Allowed values:
tagslist of strings
Document tags.
chunking_strategyenum
Strategy used to chunk the document.
Allowed values:
max_sentences_per_chunkinteger or null
Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.
split_newlinesboolean or null
Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.
overlap_sizeinteger or null
Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.
chunk_sizeinteger or null
Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.
number_of_chunksinteger
Number of Chunks in the Document.
chunks_uristring
URI path to the chunks for this document.
created_atdatetime
Document Creation Date.
updated_atdatetime
Document Update Date.

Errors