List jobs data - Byne Documentation

GET

{kb}

jobs

curl --request GET \
  --url https://app.docs.bynesoft.com/api/knowledge-base/{kb}/jobs \
  --header 'X-API-Key: <api-key>'

{
  "jobs": [
    {
      "id": "<string>",
      "status": "<string>"
    }
  ],
  "nextToken": "<string>"
}

X-API-Key

string

header

required

string | null

required

status

enum<string>

Available options:

CREATED,

IN PROGRESS,

CANCELLED,

FINISHED,

FAILED

take

integer

default:50

Required range: 1 <= x <= 50

startingToken

string | null

200

application/json

Successful Response

jobs

object[]

required

nextToken

string | null

required

curl --request GET \
  --url https://app.docs.bynesoft.com/api/knowledge-base/{kb}/jobs \
  --header 'X-API-Key: <api-key>'

{
  "jobs": [
    {
      "id": "<string>",
      "status": "<string>"
    }
  ],
  "nextToken": "<string>"
}