Documents

lookup

lookup the document(s) associated with a processId, bucketId, groupId, or projectId.

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.

get/v1/ingest/documents/{id}

Path parameters

idinteger required

a processId, bucketId, groupId, or projectId

Query parameters

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.

sort'name' | 'created'

The attribute to use to sort results

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

sortOrder'asc' | 'desc'

The order in which to sort results

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

status'queued' | 'processing' | 'error' | 'complete' | 'cancelled'

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.

Response

Look up success

countinteger

The number of results returned in the current response

nextTokenstring

totalinteger

The total number of results found

Example response

{
  "message": "The method you used is not supported for this query"
}

Changes

Changed in 13 of the 50 revisions of this API.23733

Jul 25, 2024100a68ae1698111See the full diff
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Jul 25, 2024af54b546cf621See the full diff
- ○
  the response property /// became required for the status
  response-property-became-required
Jun 29, 2024970df0d2a4e81See the full diff
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
Jun 28, 2024f97e210f14316See the full diff
- ○
  added the new optional query request parameter filter
  new-optional-request-parameter
- ○
  added the new optional query request parameter sort
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Feb 1, 2024bc7318def1071See the full diff
- ●
  added the new json enum value to the /// response property for the response status
  response-property-enum-value-added
Dec 31, 20234c5920188a7d2See the full diff
- ●
  added the new csv enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new tsv enum value to the /// response property for the response status
  response-property-enum-value-added
Nov 29, 20233bb56505863611See the full diff
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 29, 2023bf7061385e18132See the full diff
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  added the new cancelled enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new complete enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new docx enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new error enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new jpg enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new pdf enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new png enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new pptx enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new processing enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new queued enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new txt enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new xlsx enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 13, 202343657b55255e2See the full diff
- ○
  added the new optional query request parameter n
  new-optional-request-parameter
- ○
  added the new optional query request parameter nextToken
  new-optional-request-parameter
Oct 5, 20235ee59ea914aa2See the full diff
- ○
  api tag Documents added
  api-tag-added
- ○
  api tag Document removed
  api-tag-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (13 revisions)