GET
/
documents
/
v1
/
jobs
curl --request GET \
  --url https://api.tensorlake.ai/documents/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "items": [
    {
      "createdAt": "<string>",
      "datasetId": "<string>",
      "fileId": "<string>",
      "fileName": "<string>",
      "id": "<string>",
      "message": "<string>",
      "pagesParsed": 123,
      "status": "failure",
      "traceId": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

List all jobs in your current project based on the API Key you are using.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string

Cursor to paginate through the list of jobs

​
limit
integer

Limit the number of jobs to return

Required range: x >= 0
​
direction
enum<string>

Direction to paginate through the list of jobs

Available options:
next,
prev
​
filename
string

Filter jobs based on the filename used

​
dataset_name
string

Filter jobs based on the dataset name used

​
status
enum<string>

Filter jobs based on the status

Available options:
failure,
pending,
processing,
successful
​
created_after
string

Filter jobs created after the given date. Date should be in RFC3339 format

​
created_before
string

Filter jobs created before the given date. Date should be in RFC3339 format

​
updated_after
string

Filter jobs updated after the given date. Date should be in RFC3339 format

​
updated_before
string

Filter jobs updated before the given date. Date should be in RFC3339 format

Response

200
application/json
List all jobs
​
hasMore
boolean
required
​
items
object[]
required
​
nextCursor
string | null
​
prevCursor
string | null

Was this page helpful?