SAF Documentation

Appearance

@saflib/jobs-spec

Interface: operations ​

Properties ​

enqueueJob ​

enqueueJob: object

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

requestBody ​

requestBody: object

requestBody.content ​

content: object

requestBody.content.application/json ​

application/json: object

requestBody.content.application/json.concurrency_key? ​

optional concurrency_key: null | string

Description ​

Optional key limiting concurrency (at most one running job per key).

Example ​
ts
matter: Mt4k_wZ7;
requestBody.content.application/json.dedupe_key? ​

optional dedupe_key: null | string

Description ​

Optional key unique among non-terminal jobs. Re-enqueue with the same live key upserts and returns the existing job (200).

Example ​
ts
matter: Mt4k_wZ7: claim;
requestBody.content.application/json.delay_ms? ​

optional delay_ms: number

Description ​

Relative delay in milliseconds from enqueue time before the job becomes claimable. Alternative to run_at.

Example ​
ts
5000;
requestBody.content.application/json.on_behalf_of? ​

optional on_behalf_of: object

Description ​

Explicit authority override for enqueueOnBehalfOf. When present, both user_id and authority evidence are required; the job runs as that user under the given grant instead of deriving authority from the caller's request context.

requestBody.content.application/json.on_behalf_of.authority ​

authority: { kind: "request"; request_id: string; user_id: string; } | { kind: "resource"; resource_id: string; resource_kind: string; user_id: string; } | { cron_job_name: string; kind: "cron"; user_id: string; }

Type declaration ​

{ kind: "request"; request_id: string; user_id: string; }

{ kind: "resource"; resource_id: string; resource_kind: string; user_id: string; }

{ cron_job_name: string; kind: "cron"; user_id: string; }

Description ​

Evidence grant for the override (request, resource, or cron kind).

requestBody.content.application/json.on_behalf_of.user_id ​

user_id: string

Description ​

Acting user for the enqueued job.

Example ​
ts
Us7k_pQ2;
requestBody.content.application/json.operation_id ​

operation_id: string

Description ​

Target OpenAPI operationId (must exist and carry the background tag).

Example ​
ts
jobsDemoStepB;
requestBody.content.application/json.priority? ​

optional priority: number

Description ​

Claim priority; higher values are claimed first. Defaults to 0.

Example ​
ts
0;
requestBody.content.application/json.request ​

request: object

Description ​

Capped request payload for the target operation (serialized size ≤ 16 KB including this object's path_params/query/body).

requestBody.content.application/json.request.body? ​

optional body: unknown

Description ​

JSON request body for the target operation, when any.

requestBody.content.application/json.request.path_params? ​

optional path_params: object

Index Signature ​

[key: string]: unknown

Description ​

Path template substitutions keyed by parameter name.

requestBody.content.application/json.request.query? ​

optional query: object

Index Signature ​

[key: string]: unknown

Description ​

Query string parameters keyed by name.

requestBody.content.application/json.run_at? ​

optional run_at: string

Format: date-time

Description ​

Absolute earliest claim time. Ignored when delay_ms is also set if the implementation prefers delay_ms; typically use one or the other.

Example ​
ts
2026-08-06T21:00:00.000Z

responses ​

responses: object

responses.200 ​

200: object

Description ​

Existing job returned after a dedupe-key upsert.

responses.200.content ​

content: object

responses.200.content.application/json ​

application/json: object

responses.200.content.application/json.job ​

job: object

responses.200.content.application/json.job.attempt ​

attempt: number

Description ​

Number of delivery attempts consumed so far (0 before first claim).

Example ​
ts
0;
responses.200.content.application/json.job.authority ​

authority: { kind: "request"; request_id: string; user_id: string; } | { kind: "resource"; resource_id: string; resource_kind: string; user_id: string; } | { cron_job_name: string; kind: "cron"; user_id: string; }

Type declaration ​

{ kind: "request"; request_id: string; user_id: string; }

{ kind: "resource"; resource_id: string; resource_kind: string; user_id: string; }

{ cron_job_name: string; kind: "cron"; user_id: string; }

Description ​

Root grant for the job chain (copied verbatim by children). Discriminated on kind. Wire form excludes the embedded enqueue assertion token.

responses.200.content.application/json.job.concurrency_key ​

concurrency_key: null | string

Description ​

Optional key limiting concurrency: at most one running job per key (e.g. matter:{id}).

Example ​
ts
matter: demo - 1;
responses.200.content.application/json.job.created_at ​

created_at: string

Format: date-time

Description ​

When the job row was created.

Example ​
ts
2026-08-06T20:59:55.000Z
responses.200.content.application/json.job.dedupe_key ​

dedupe_key: null | string

Description ​

Optional key unique among non-terminal jobs. Re-enqueue with the same live key upserts (pushes run_at, refreshes request) and returns the existing job.

Example ​
ts
matter:demo-1:claim
responses.200.content.application/json.job.enqueued_by_operation_id ​

enqueued_by_operation_id: string

Description ​

Calling operationId that enqueued this job (trigger-map edge).

Example ​
ts
startJobsDemo;
responses.200.content.application/json.job.finished_at ​

finished_at: null | string

Format: date-time

Description ​

When the job reached a terminal status; null while still active.

Example ​
ts
null;
responses.200.content.application/json.job.id ​

id: string

Description ​

Short identifier for the job (from generateShortId).

Example ​
ts
Jb3k_mN7;
responses.200.content.application/json.job.max_attempts ​

max_attempts: number

Description ​

Maximum delivery attempts before the job becomes dead (exhausted).

Example ​
ts
5;
responses.200.content.application/json.job.operation_id ​

operation_id: string

Description ​

Target OpenAPI operationId resolved at delivery time.

Example ​
ts
jobsDemoStepB;
responses.200.content.application/json.job.original_request_id ​

original_request_id: string

Description ​

Chain-root request id (user request / webhook X-Request-ID, or cron-tick id). Copied from parent on chained enqueues; joins audit_event.request_id.

Example ​
ts
r - abc123;
responses.200.content.application/json.job.parent_job_id ​

parent_job_id: null | string

Description ​

Short id of the job that enqueued this one, or null at the chain root.

Example ​
ts
null;
responses.200.content.application/json.job.priority ​

priority: number

Description ​

Claim priority; higher values are claimed first. Default 0.

Example ​
ts
0;
responses.200.content.application/json.job.request ​

request: object

Description ​

Capped request payload delivered to the target operation (serialized size ≤ 16 KB). Path params, query, and body are optional and substituted into the operation's path template / request.

Example ​
ts
{
             *       "body": {
             *         "failures_before_success": 2
             *       }
             *     }
responses.200.content.application/json.job.request.body? ​

optional body: unknown

Description ​

JSON request body for the target operation, when any.

responses.200.content.application/json.job.request.path_params? ​

optional path_params: object

Index Signature ​

[key: string]: unknown

Description ​

Path template substitutions keyed by parameter name.

responses.200.content.application/json.job.request.query? ​

optional query: object

Index Signature ​

[key: string]: unknown

Description ​

Query string parameters keyed by name.

responses.200.content.application/json.job.result ​

result: null | { error_body?: null | string; status_code?: number; terminal_reason?: null | "exhausted" | "permanent-status" | "rejected-by-endpoint" | "auth-unresolvable" | "cancelled-by-admin" | "cancelled-by-chain"; }

Type declaration ​

null

{ error_body?: null | string; status_code?: number; terminal_reason?: null | "exhausted" | "permanent-status" | "rejected-by-endpoint" | "auth-unresolvable" | "cancelled-by-admin" | "cancelled-by-chain"; }

Description ​

Outcome of the latest terminal or failed attempt. Null while the job has not yet finished an attempt that records a result. error_body is set only on failure and capped at 8 KB.

responses.200.content.application/json.job.run_at ​

run_at: string

Format: date-time

Description ​

Earliest time the job may be claimed for delivery.

Example ​
ts
2026-08-06T21:00:00.000Z
responses.200.content.application/json.job.started_at ​

started_at: null | string

Format: date-time

Description ​

When the current (or last) delivery attempt started; null if never claimed.

Example ​
ts
null;
responses.200.content.application/json.job.status ​

status: "pending" | "running" | "retrying" | "succeeded" | "dead" | "cancelled"

Description ​

Lifecycle state. pending/retrying are claimable; running is in delivery; succeeded/dead/cancelled are terminal.

Example ​
ts
pending
@enum {string}
responses.200.content.application/json.job.user_id ​

user_id: string

Description ​

Acting user whose authority the job runs under.

Example ​
ts
Us7k_pQ2;
responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.201 ​

201: object

Description ​

Job created.

responses.201.content ​

content: object

responses.201.content.application/json ​

application/json: object

responses.201.content.application/json.job ​

job: object

responses.201.content.application/json.job.attempt ​

attempt: number

Description ​

Number of delivery attempts consumed so far (0 before first claim).

Example ​
ts
0;
responses.201.content.application/json.job.authority ​

authority: { kind: "request"; request_id: string; user_id: string; } | { kind: "resource"; resource_id: string; resource_kind: string; user_id: string; } | { cron_job_name: string; kind: "cron"; user_id: string; }

Type declaration ​

{ kind: "request"; request_id: string; user_id: string; }

{ kind: "resource"; resource_id: string; resource_kind: string; user_id: string; }

{ cron_job_name: string; kind: "cron"; user_id: string; }

Description ​

Root grant for the job chain (copied verbatim by children). Discriminated on kind. Wire form excludes the embedded enqueue assertion token.

responses.201.content.application/json.job.concurrency_key ​

concurrency_key: null | string

Description ​

Optional key limiting concurrency: at most one running job per key (e.g. matter:{id}).

Example ​
ts
matter: demo - 1;
responses.201.content.application/json.job.created_at ​

created_at: string

Format: date-time

Description ​

When the job row was created.

Example ​
ts
2026-08-06T20:59:55.000Z
responses.201.content.application/json.job.dedupe_key ​

dedupe_key: null | string

Description ​

Optional key unique among non-terminal jobs. Re-enqueue with the same live key upserts (pushes run_at, refreshes request) and returns the existing job.

Example ​
ts
matter:demo-1:claim
responses.201.content.application/json.job.enqueued_by_operation_id ​

enqueued_by_operation_id: string

Description ​

Calling operationId that enqueued this job (trigger-map edge).

Example ​
ts
startJobsDemo;
responses.201.content.application/json.job.finished_at ​

finished_at: null | string

Format: date-time

Description ​

When the job reached a terminal status; null while still active.

Example ​
ts
null;
responses.201.content.application/json.job.id ​

id: string

Description ​

Short identifier for the job (from generateShortId).

Example ​
ts
Jb3k_mN7;
responses.201.content.application/json.job.max_attempts ​

max_attempts: number

Description ​

Maximum delivery attempts before the job becomes dead (exhausted).

Example ​
ts
5;
responses.201.content.application/json.job.operation_id ​

operation_id: string

Description ​

Target OpenAPI operationId resolved at delivery time.

Example ​
ts
jobsDemoStepB;
responses.201.content.application/json.job.original_request_id ​

original_request_id: string

Description ​

Chain-root request id (user request / webhook X-Request-ID, or cron-tick id). Copied from parent on chained enqueues; joins audit_event.request_id.

Example ​
ts
r - abc123;
responses.201.content.application/json.job.parent_job_id ​

parent_job_id: null | string

Description ​

Short id of the job that enqueued this one, or null at the chain root.

Example ​
ts
null;
responses.201.content.application/json.job.priority ​

priority: number

Description ​

Claim priority; higher values are claimed first. Default 0.

Example ​
ts
0;
responses.201.content.application/json.job.request ​

request: object

Description ​

Capped request payload delivered to the target operation (serialized size ≤ 16 KB). Path params, query, and body are optional and substituted into the operation's path template / request.

Example ​
ts
{
             *       "body": {
             *         "failures_before_success": 2
             *       }
             *     }
responses.201.content.application/json.job.request.body? ​

optional body: unknown

Description ​

JSON request body for the target operation, when any.

responses.201.content.application/json.job.request.path_params? ​

optional path_params: object

Index Signature ​

[key: string]: unknown

Description ​

Path template substitutions keyed by parameter name.

responses.201.content.application/json.job.request.query? ​

optional query: object

Index Signature ​

[key: string]: unknown

Description ​

Query string parameters keyed by name.

responses.201.content.application/json.job.result ​

result: null | { error_body?: null | string; status_code?: number; terminal_reason?: null | "exhausted" | "permanent-status" | "rejected-by-endpoint" | "auth-unresolvable" | "cancelled-by-admin" | "cancelled-by-chain"; }

Type declaration ​

null

{ error_body?: null | string; status_code?: number; terminal_reason?: null | "exhausted" | "permanent-status" | "rejected-by-endpoint" | "auth-unresolvable" | "cancelled-by-admin" | "cancelled-by-chain"; }

Description ​

Outcome of the latest terminal or failed attempt. Null while the job has not yet finished an attempt that records a result. error_body is set only on failure and capped at 8 KB.

responses.201.content.application/json.job.run_at ​

run_at: string

Format: date-time

Description ​

Earliest time the job may be claimed for delivery.

Example ​
ts
2026-08-06T21:00:00.000Z
responses.201.content.application/json.job.started_at ​

started_at: null | string

Format: date-time

Description ​

When the current (or last) delivery attempt started; null if never claimed.

Example ​
ts
null;
responses.201.content.application/json.job.status ​

status: "pending" | "running" | "retrying" | "succeeded" | "dead" | "cancelled"

Description ​

Lifecycle state. pending/retrying are claimable; running is in delivery; succeeded/dead/cancelled are terminal.

Example ​
ts
pending
@enum {string}
responses.201.content.application/json.job.user_id ​

user_id: string

Description ​

Acting user whose authority the job runs under.

Example ​
ts
Us7k_pQ2;
responses.201.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.400 ​

400: object

Description ​

Request payload exceeds the 16 KB serialized size cap.

responses.400.content ​

content: object

responses.400.content.application/json ​

application/json: object

responses.400.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.400.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.401 ​

401: object

Description ​

Unauthorized - missing or invalid assertion.

responses.401.content ​

content: object

responses.401.content.application/json ​

application/json: object

responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.403 ​

403: object

Description ​

Forbidden - calling operation is not allowed to enqueue the target (trigger-map violation).

responses.403.content ​

content: object

responses.403.content.application/json ​

application/json: object

responses.403.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.403.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.422 ​

422: object

Description ​

Unknown operationId, or the target operation is not tagged background.

responses.422.content ​

content: object

responses.422.content.application/json ​

application/json: object

responses.422.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.422.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
responses.422.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.429 ​

429: object

Description ​

Spawn cap exceeded for this originalRequestId chain.

responses.429.content ​

content: object

responses.429.content.application/json ​

application/json: object

responses.429.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

responses.429.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
responses.429.headers ​

headers: object

Index Signature ​

[name: string]: unknown