Loading...
Skip to main content

Get a Document.​

Get a Document.

Path Parameters
    corpusId string required

    The ID of the corpus owning the document to retrieve.

    sourceId string required

    The ID of the source owning the document to retrieve.

    documentId string required

    The ID of the document to retrieve.

Responses

OK

Schema
    document object

    A single complete source of information included in a corpus. In the most straight-forward case, this could be a webpage with authoritative information on some subject. However, documents can also be created from other documents by some processing step and may not even be text-based. For example, you could have an audio document that contains the source of truth on some subject and that produces a separate text transcript document during processing. The derived transcript document could then be embedded for use in queries.

    corpusId string

    The corpus that this document belongs to.

    sourceId string

    The source that this document belongs to.

    documentId string

    The unique ID of this document.

    mimeType string

    The MIME type of the document. https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types

    downloadUrl string

    A URL from which this document's contents can be downloaded. This URL may expire after a few minutes.

    metadata object

    Metadata about the document.

    publicUrl string

    The public URL of the document, if any.

    language string

    The BCP47 language code of the document, if known.

    title string

    The title of the document, if known.

    description string

    The description of the document, if known.

    published date-time

    The timestamp that the document was published, if known.

    created date-time

    When this Document was created in the Fixie system.

    See the metadata.published field for the timestamp that the document was originally published, if known.

    sizeBytes string

    The size of the document, in bytes, as it is stored by Fixie.

    Note that a Document may be the result of processing a source document, which may involve conversion from another format. This value represents the size of the content stored by Fixie, which may not match the original source document.

Loading...