GET
/
documents
/
v1
/
datasets
/
{dataset_name}
curl --request GET \
  --url https://api.tensorlake.ai/documents/v1/datasets/{dataset_name} \
  --header 'Authorization: Bearer <token>'
{
  "analytics": {
    "totalErrorJobs": 1,
    "totalJobs": 1,
    "totalProcessingJobs": 1,
    "totalSuccessfulJobs": 1
  },
  "createdAt": "<string>",
  "description": "<string>",
  "extractSettings": null,
  "id": "<string>",
  "jobs": {
    "items": [
      {
        "createdAt": "<string>",
        "errorMessage": "<string>",
        "fileId": "<string>",
        "fileName": "<string>",
        "id": "<string>",
        "outputsUrl": "<string>",
        "status": "failure",
        "updatedAt": "<string>"
      }
    ],
    "nextCursor": "<string>",
    "prevCursor": "<string>",
    "totalPages": 1
  },
  "name": "<string>",
  "parseSettings": null,
  "status": "idle"
}

Retrieve the details for a given dataset. The dataset will report idle if there are no document parsing or structured extraction executions in progress.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
dataset_name
string
required

Response

200
application/json
Get a dataset
​
analytics
object
required
​
createdAt
string
required
​
id
string
required
​
name
string
required
​
description
string | null
​
extractSettings
object | null
​
jobs
object
​
parseSettings
object | null
​
status
enum<string>
Available options:
idle,
processing

Was this page helpful?

Dataset outputsList your datasets