List Jobs

client.aiSearch.instances.jobs.list(, , ?): V4PagePaginationArray<JobListResponse { id, source, description, 4 more } >

GET/accounts/{account_id}/ai-search/instances/{id}/jobs

Lists indexing jobs for an AI Search instance.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

id: string

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

params: JobListParams { account_id, page, per_page }

account_id: string

Path param

page?: number

Query param

minimum1

per_page?: number

Query param

maximum50

minimum0

ReturnsExpand Collapse

JobListResponse { id, source, description, 4 more }

id: string

source: "user" | "schedule"

One of the following:

"user"

"schedule"

description?: string

end_reason?: string

ended_at?: string

last_seen_at?: string

started_at?: string

List Jobs

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const jobListResponse of client.aiSearch.instances.jobs.list('my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
})) {
  console.log(jobListResponse.id);
}

{
  "result": [
    {
      "id": "id",
      "source": "user",
      "description": "description",
      "end_reason": "end_reason",
      "ended_at": "ended_at",
      "last_seen_at": "last_seen_at",
      "started_at": "started_at"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "id",
      "source": "user",
      "description": "description",
      "end_reason": "end_reason",
      "ended_at": "ended_at",
      "last_seen_at": "last_seen_at",
      "started_at": "started_at"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}