logo
Documents

list

get
https://api.groundx.ai/api/v1/ingest/documents

lookup all documents across all resources which are currently on GroundX

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

Execute an API Request

Query
ninteger

The maximum number of returned documents. Accepts 1-100 with a default of 20.

filterstring

Only documents with names that contain the filter string will be returned in the results.

sortstring

The document attribute that will be used to sort the results.

sortOrderstring

The order in which to sort the results. A value for sort must also be set.

statusstring

A status filter on the get documents query. If this value is set, then only documents with this status will be returned in the results.

nextTokenstring

A token for pagination. If the number of documents for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n documents.

Authorization
Request
Installation
$
npm install groundx-typescript-sdk
1
Loading...

Response fields

object
documentsarray of objects
nextTokenstring
1
{
2
"documents": [
3
{
4
"bucketId": 0,
5
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
6
"fileName": "string",
7
"fileSize": "1.4MB",
8
"fileType": "txt",
9
"processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
10
"searchData": {},
11
"sourceUrl": "http://example.com",
12
"status": "queued",
13
"statusMessage": "string",
14
"xrayUrl": "http://example.com"
15
}
16
],
17
"nextToken": "string"
18
}