Skip to content
Start here

List Job Logs

client.aiSearch.instances.jobs.logs(stringid, stringjobId, JobLogsParams { account_id, page, per_page } params, RequestOptionsoptions?): JobLogsResponse { id, created_at, message, message_type }
GET/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

Lists log entries for an AI Search indexing job.

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
jobId: string
params: JobLogsParams { account_id, page, per_page }
account_id: string

Path param

page?: number

Query param

minimum1
per_page?: number

Query param

maximum500
minimum0
ReturnsExpand Collapse
JobLogsResponse = Array<JobLogsResponseItem>
id: number
created_at: number
message: string
message_type: number

List Job Logs

import Cloudflare from 'cloudflare';

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

const response = await client.aiSearch.instances.jobs.logs('my-ai-search', 'job_id', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(response);
{
  "result": [
    {
      "id": 0,
      "created_at": 0,
      "message": "message",
      "message_type": 0
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}
Returns Examples
{
  "result": [
    {
      "id": 0,
      "created_at": 0,
      "message": "message",
      "message_type": 0
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}