Get a job by ID
GET/v2/jobs/:job_id
Get a job by a specific ID. Jobs are background processes like replacing the filterable metadata attributes.
Request
Path Parameters
Possible values: Value must match regular expression job_.+$
The ID of job to get.
Responses
- 200
- 403
- 404
A job.
- application/json
- Schema
- Example (from schema)
Schema
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.
{
"id": "string",
"type": "rebuild_vector_index",
"corpus_keys": [
"my-corpus"
],
"state": "unknown",
"created_at": "2024-09-05T02:15:29.489Z",
"started_at": "2024-09-05T02:15:29.489Z",
"completed_at": "2024-09-05T02:15:29.489Z"
}
Permissions do not allow retrieving a job.
- 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"
}
Job not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID cannot found.
ID of the request that can be used to help Vectara support debug what went wrong.
{
"id": "string",
"messages": [
"string"
],
"request_id": "string"
}