Documents

get

Look up an existing document by documentId.

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/document/{documentId}

Path parameters

documentIdstring uuid required

The documentId of the document for which GroundX information will be provided.

Response

Look up success

Example response

{
  "document": {
    "fileSize": "1.4MB"
  }
}

Changes

Changed in 9 of the 50 revisions of this API.51927

Jul 25, 2024af54b546cf621See the full diff
- ○
  the response property / became required for the status
  response-property-became-required
Jun 28, 2024f97e210f14311See the full diff
- ○
  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, 2023bf7061385e18113See the full diff
- ▲
  for the path request parameter documentId, the format changed from no format to uuid
  request-parameter-type-changed
- ●
  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
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
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
Oct 4, 20237d474e21a1082See the full diff
- ○
  api operation id Document_get was added
  api-operation-id-added
- ○
  api tag Document added
  api-tag-added
Oct 4, 202379c42de78d2f4220See the full diff
- ▲
  the response property / became optional for the status
  response-property-became-optional
- ▲
  the / response's property format changed from uuid to no format for status
  response-property-type-changed
- ▲
  the / response's property format changed from uuid to no format for status
  response-property-type-changed
- ▲
  the / response's property format changed from uri to no format for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  api operation id Document_get removed and replaced with
  api-operation-id-removed
- ○
  api tag Documents removed
  api-tag-removed
- ○
  for the path request parameter documentId, the format was generalized from uuid to no format
  request-parameter-type-generalized
- ○
  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
- ○
  removed the cancelled enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the complete enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the csv enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the docx enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the error enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the jpg enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the json enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the pdf enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the png enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the pptx enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the processing enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the queued enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the tsv enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the txt enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the xlsx enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 30 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history