Klineo/Docs
Open app ↗

API v1 schemas

v1 · BackgroundJob

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
id Yes string Min length: 1
kind Yes string Allowed: DIAGNOSTIC_SIMULATION, INDEXED_SIMULATION, AI_OUTPUT, REPORT_GENERATION
resultId Yes string Min length: 1
state Yes BackgroundJobState —
attempts Yes integer Minimum: 0; Maximum: 5
availableAt Yes string Format: date-time
lastErrorCode No string —
result No object Additional properties rejected
result.resourceType Yes string Allowed: simulation, ai_output, report
result.resourceIds Yes Array of string Min items: 1; Max items: 1
result.evidenceHashes Yes Array of string Min items: 1; Max items: 1
createdAt Yes string Format: date-time
updatedAt Yes string Format: date-time
completedAt No string Format: date-time

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/BackgroundJob in the OpenAPI contract.