API Reference

AI Search

Namespaces

Instances

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Jobs

List Jobs

client.aiSearch.namespaces.instances.jobs.list(stringname, stringid, JobListParams { account_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<JobListResponse { id, source, description, 4 more } >

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

Create new job

client.aiSearch.namespaces.instances.jobs.create(stringname, stringid, JobCreateParams { account_id, description } params?, RequestOptionsoptions?): JobCreateResponse { id, source, description, 4 more }

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs

Get a Job Details

client.aiSearch.namespaces.instances.jobs.get(stringname, stringid, stringjobId, JobGetParams { account_id } params?, RequestOptionsoptions?): JobGetResponse { id, source, description, 4 more }

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

Change Job Status

client.aiSearch.namespaces.instances.jobs.update(stringname, stringid, stringjobId, JobUpdateParams { account_id, action } params, RequestOptionsoptions?): JobUpdateResponse { id, source, description, 4 more }

PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}

List Job Logs

client.aiSearch.namespaces.instances.jobs.logs(stringname, stringid, stringjobId, JobLogsParams { account_id, page, per_page } params?, RequestOptionsoptions?): JobLogsResponse { id, created_at, message, message_type }

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs

ModelsExpand 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

JobCreateResponse { 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

JobGetResponse { 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

JobUpdateResponse { 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

JobLogsResponse = Array<JobLogsResponseItem>

id: number

created_at: number

message: string

message_type: number