List Documents for a Source.

List Documents for a Source.

Path Parameters

corpusId string required

The ID of the corpus owning the source to list documents in.

sourceId string required

The parent source to list documents in.

Query Parameters

limit int32

The maximum number of results to return. The service may return fewer than this value. If unspecified, the service will choose a sensible default. The maximum allowed value is 1000.

offset int32

The number of entries in the result set to skip.

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

documents object[]
The list of Documents.
Array [
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 a document. This is typically not included in the document's chunks, but can be used for filtering or citations. Derived documents inherit metadata from their source documents in general.
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.
]
pageInfo object

Information about the page of results returned.

requestedPageSize int32

The number of results requested.

requestedOffset int32

The offset specified in the request.

totalResultCount int32

The total number of results available.

{
  "documents": [
    {
      "corpusId": "string",
      "sourceId": "string",
      "documentId": "string",
      "mimeType": "string",
      "downloadUrl": "string",
      "metadata": {
        "publicUrl": "string",
        "language": "string",
        "title": "string",
        "description": "string",
        "published": "2024-03-07T22:56:08.243Z"
      },
      "created": "2024-03-07T22:56:08.243Z",
      "sizeBytes": "string"
    }
  ],
  "pageInfo": {
    "requestedPageSize": 0,
    "requestedOffset": 0,
    "totalResultCount": 0
  }
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...