Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Jobs

List jobs

Lists jobs for the account. Jobs are background processes, such as replacing the filterable metadata attributes.

get/v2/jobs

Query parameters

corpus_keyCorpusKey[]

The unique key identifying the corpus with the job.

[
  "my-corpus"
]
afterstring date-time

Filter by jobs created after a particular date-time.

stateJobState[]

Filter by jobs in particular states.

limitinteger

The maximum number of jobs to return at one time.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of jobs.

Example response

{
  "jobs": [
    {
      "id": "job_1234",
      "corpus_keys": [
        "my-corpus"
      ]
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}