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

job_id stringrequired

Possible values: Value must match regular expression job_.+$

The ID of job to get.

Responses

200

A job.

application/json

Schema

Schema

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.

Example (from schema)

{
  "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"
}

403

Permissions do not allow retrieving a job.

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"
}

404

Job not found.

application/json

Schema

Schema

id string

The ID cannot found.

messages message[]
request_id string

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

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...