The Job Object
The job object represents the current state of an asynchronous MidLyr job. It is returned by the Get Job endpoint.
Object Shape
Section titled “Object Shape”{ "id": "job_01HY3K4M7QR9VP2N8WYJF5GTB", "type": "screen_analysis", "status": "succeeded", "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:12Z", "result": { "type": "analysis.screen.result", "riskScore": 75, "findings": [] }, "error": null}Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id | string | Stable job id returned by an async submit endpoint. |
type | string | Job type discriminator. v1 defines screen_analysis and risk_assessment. |
status | string | One of running, succeeded, or failed. |
createdAt | string | ISO 8601 UTC timestamp of when the job was submitted. |
updatedAt | string | ISO 8601 UTC timestamp of the last status transition. |
result | object or null | Present only when status is succeeded. Shape depends on type — see Result Shapes by Job Type below. |
error | object or null | Present only when status is failed. Shape: { code, message }. |
Result Shapes by Job Type
Section titled “Result Shapes by Job Type”type | result shape |
|---|---|
screen_analysis | Screen Analysis Result Object |
risk_assessment | Risk Assessment Result Object |
Status Values
Section titled “Status Values”| Value | Meaning |
|---|---|
running | Work is still in progress. result and error are both null. |
succeeded | Work completed successfully. result is populated. |
failed | Work reached a terminal failure. error is populated. |