Tasks

Create and enqueue a task.

Provide exactly one of payload or payload_base64. If the deployment is configured with a TaskVerificationKey, the caller must also supply a valid signature; the server does not sign on behalf of callers.

post/v1/tasks

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/choria-io/apis/asyncjobs-http-api/docs/v1/tasks/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

Best-effort idempotency. Replays within a server-defined retention window return the original response.

Request body

typestring required

queuestring

payloadunknown

payload_base64string byte

Pre-encoded payload bytes for non-JSON content.

deadlinestring date-time

Absolute RFC3339 cut-off for starting the task.

max_triesinteger

dependenciesstring[]

load_dependenciesboolean

signaturestring

Hex-encoded ed25519 signature computed over the library's signing envelope. Required only when the deployment is configured with a TaskVerificationKey.

Response

Task created and enqueued.

idstring required

typestring required

queuestring

dependenciesstring[]

dependency_resultsobject

load_dependenciesboolean

payloadstring byte required

Base64-encoded payload bytes.

deadlinestring date-time

max_triesinteger

createdstring date-time required

triedstring date-time

triesinteger

last_errstring

signaturestring

Hex-encoded ed25519 signature, when present.

Changes

No recorded changes to this operation across all 1 revision of this API.