List jobs

GET 
/v2/jobs

List jobs for the account. Jobs are background processes like replacing the filterable metadata attributes.

Request

Query Parameters

corpus_key CorpusKey[]

Possible values: <= 50 characters, Value must match regular expression [a-zA-Z0-9_\=\-]+$

The unique key identifying the corpus with the job.

after date-time

Filter by jobs created after a particular date-time.

state JobState[]

Possible values: [unknown, queued, started, completed, failed, failed_will_retry, aborted]

Filter by jobs in particular states.

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of jobs to return at one time.

page_key string

Used to retrieve the next page of jobs after the limit has been reached.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

List of jobs.

application/json

Schema

Schema

jobs object[]
An array of jobs.
Array [
id string
Possible values: Value must match regular expression job_.+$
The ID of the job.
type string
Possible values: [rebuild_vector_index, replace_filter_attributes, unknown]
The type of job.
corpus_keys CorpusKey[]
Possible values: <= 50 characters, Value must match regular expression [a-zA-Z0-9_\=\-]+$
The corpora that this job belongs to. It may not belong to any corpora.
state JobState
Possible values: [unknown, queued, started, completed, failed, failed_will_retry, aborted]
created_at date-time
Specifies when the job was created.
started_at date-time
Specifies when the job was started.
completed_at date-time
Specifies when the job was completed.
created_by_username string
The username of the user who created the job. This property may be missing, e.g., if the job was created by the system, not a user.
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

{
  "jobs": [
    {
      "id": "string",
      "type": "rebuild_vector_index",
      "corpus_keys": [
        "my-corpus"
      ],
      "state": "unknown",
      "created_at": "2024-10-29T01:49:06.240Z",
      "started_at": "2024-10-29T01:49:06.240Z",
      "completed_at": "2024-10-29T01:49:06.240Z",
      "created_by_username": "string"
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

403

Permissions do not allow listing jobs.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

Loading...