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

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

Create new job

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

Get a Job Details

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

Change Job Status

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

List Job Logs

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

ModelsExpand Collapse

JobListResponse object { id, source, description, 4 more }

id: string

source: "user" or "schedule"

One of the following:

"user"

"schedule"

description: optional string

end_reason: optional string

ended_at: optional string

last_seen_at: optional string

started_at: optional string

JobCreateResponse object { id, source, description, 4 more }

id: string

source: "user" or "schedule"

One of the following:

"user"

"schedule"

description: optional string

end_reason: optional string

ended_at: optional string

last_seen_at: optional string

started_at: optional string

JobGetResponse object { id, source, description, 4 more }

id: string

source: "user" or "schedule"

One of the following:

"user"

"schedule"

description: optional string

end_reason: optional string

ended_at: optional string

last_seen_at: optional string

started_at: optional string

JobUpdateResponse object { id, source, description, 4 more }

id: string

source: "user" or "schedule"

One of the following:

"user"

"schedule"

description: optional string

end_reason: optional string

ended_at: optional string

last_seen_at: optional string

started_at: optional string

JobLogsResponse = array of object { id, created_at, message, message_type }

id: number

created_at: number

message: string

message_type: number