List jobs
GET/v2/jobs
List jobs for the account. Jobs are background processes like replacing the filterable metadata attributes.
Request
Query Parameters
Possible values: <= 50 characters
, Value must match regular expression [a-zA-Z0-9_\=\-]+$
The unique key identifying the corpus with the job.
Get jobs after a date time.
Possible values: [unknown
, queued
, started
, completed
, failed
, failed_will_retry
, aborted
]
Indicates the states the jobs can be in.
Possible values: >= 1
and <= 100
Default value: 10
The maximum number of documents to return at one time.
Used to the retrieve the next page of documents after the limit has been reached.
Responses
- 200
- 403
List of jobs.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
jobs object[]
An array of jobs.
Possible values: Value must match regular expression job_.+$
The ID of the job.
Possible values: [rebuild_vector_index
, replace_filter_attributes
, unknown
]
The type of job.
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.
Possible values: [unknown
, queued
, started
, completed
, failed
, failed_will_retry
, aborted
]
Specifies when the job was created.
Specifies when the job was started.
Specifies when the job was completed.
metadata object
The standard metadata in the response of a list operation.
When requesting the next page of this list, this is needed as a query parameter.
{
"jobs": [
{
"id": "string",
"type": "rebuild_vector_index",
"corpus_keys": [
"my-corpus"
],
"state": "unknown",
"created_at": "2024-07-11T20:03:46.408Z",
"started_at": "2024-07-11T20:03:46.408Z",
"completed_at": "2024-07-11T20:03:46.408Z"
}
],
"metadata": {
"page_key": "string"
}
}
Permissions do not allow listing jobs.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}