Skip to main content
GET
/
documents
cURL
curl --request GET \
  --url https://api.lucidtech.ai/{basePath}/documents \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "updatedTime": "<string>",
      "metadata": {},
      "retentionInDays": 913,
      "updatedBy": "<string>",
      "description": "<string>",
      "createdBy": "<string>",
      "name": "<string>",
      "createdTime": "<string>",
      "documentId": "<string>",
      "contentMD5": "<string>",
      "ocrFileUrl": "<string>",
      "agentRunId": "<string>",
      "content": "<string>",
      "groundTruth": [
        {
          "label": "<string>",
          "value": "<string>",
          "pages": [
            123
          ],
          "rawValue": "<string>",
          "confidence": 0.5
        }
      ],
      "consentId": "<string>",
      "datasetId": "<string>",
      "fileUrl": "<string>",
      "contentType": "application/pdf",
      "annotationFileUrl": "<string>"
    }
  ],
  "nextToken": "<string>",
  "consentId": [
    "<string>"
  ],
  "datasetId": [
    "<string>"
  ],
  "sortBy": "createdTime",
  "order": "ascending"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

datasetId
string
nextToken
string
order
string
documentId
string
maxResults
string
sortBy
string

Response

200 response

documents
object[]
required
nextToken
string | null
required
Maximum string length: 4096
datasetId
string[]
sortBy
enum<string>
Available options:
createdTime
order
enum<string>
Available options:
ascending,
descending