Skip to main content

List Documents

GET 
/documents

A list of Datasphere Documents

Request​

Responses​

The request has succeeded.

Schema

    data

    object[]

    required

  • Array [

    • id uuidrequired

    Unique ID of a Document.

    filename stringrequired

    Name of the Document.

    Example: player_list.pdf
    status DocumentStatus (string)required

    The current Status of the Document.

    Possible values: [submitted, in_progress, completed, failed]

    tags string[]required

    Document tags.

    Example: ["sports","football","game"]
    chunking_strategy ChunkingStrategy (string)required

    Strategy to use when chunking the document.

    Possible values: [sentence, paragraph, page, sliding]

    max_sentences_per_chunk stringrequired

    Max Sentences per Chunk (only used for chunking type 'sentence')

    Example: 80
    split_newlines booleanrequired

    Split on Newlines (only used for chunking type 'sentence')

    Example: true
    overlap_size stringrequired

    Overlap Size (only used for chunking type 'sliding')

    Example: 10
    chunk_size stringrequired

    Chunk Size (only used for chunking type 'sliding')

    Example: 50
    number_of_chunks integerrequired

    Number of Chunks in the Document.

    Example: 2345
    created_at date-timerequired

    Document Creation Date.

    Example: 2024-05-06T12:20-12Z
    updated_at date-timerequired

    Document Update Date.

    Example: 2024-05-06T12:20-12Z

  • ]

    • links

    object

    required

    self urirequired

    Link of the current page

    Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50
    first urirequired

    Link to the first page

    Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50
    next urirequired

    Link to the next page

    Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca