API Reference

Prism

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Imports

Get the status of an import job

client.prism.imports.get(stringjobID, ImportGetParams { teamId } params?, RequestOptionsoptions?): ImportGetResponse { job_id, status, total, 8 more }

GET/v2/prism/{teamId}/imports/{jobId}

ModelsExpand Collapse

ImportGetResponse { job_id, status, total, 8 more }

Status snapshot of an import job. Same shape used by the POST /import response and by GET /imports/{jobId}.

job_id: string | null

Null for sync imports (results inlined). Set for async imports.

status: "complete" | "processing" | "failed"

One of the following:

"complete"

"processing"

"failed"

total: number

Total number of rows in the import.

created_at?: string

formatdate-time

error?: Error { code, message }

Set when status=failed; describes the job-level failure (not per-row).

code?: string

message?: string

expires_at?: string

formatdate-time

failed?: number

processed?: number

Rows that have been attempted (succeeded + failed).

results?: Array<Result>

Per-row outcomes. Always present for sync imports; populated for async imports once the job reaches complete.

id?: string | null

formatuuid

created?: boolean

error?: Error { code, message }

code?: string

message?: string

existing?: boolean

True if the row matched an existing record via the dedupe key.

succeeded?: number

updated_at?: string

formatdate-time