VORQ Docs
Reference

Jobs and results

JobHandle, and the TextResult, MediaResult, EmbeddingResult and JobError result types.

JobHandle

Returned by client.submit(…), or built from a stored id with client.job(jobId) (no network call; never creates a job).

handle.id: string
handle.taskCid: string | null
handle.status(): Promise<string>
handle.result(timeoutSeconds?: number): Promise<TextResult | MediaResult | EmbeddingResult>
handle.cancel(): Promise<void>

id

The job id, a 0x-prefixed 32-byte hex string. Store it before waiting on anything.

taskCid

The content id of the job's sealed input, from the submission's answer. null on a handle built with client.job(id).

status()

One GET /v1/jobs/{id}. Returns queued, in_progress, completed, failed or cancelled; the last three are terminal.

result()

Polls until the job is terminal, then fetches the result by content id and opens it with the client's cipher.

  • Polls every window ÷ 60 seconds, held between 2 and 60 seconds.
  • Without timeoutSeconds, the wait is the job's window, counted from the call. A handle from submit knows the window; a handle from client.job(id) reads vorq.sla_secs from the job row, and assumes 1 hour if the row names none.
  • On expiry, raises WaitTimeout with .jobId. The job continues.
  • A failed or cancelled job raises JobFailed with .errorType.
  • A completed job that names no result, or whose bytes are not a result or do not open with this client's key, raises ResultIntegrityError.
  • A job row stating a window of zero or less seconds raises ValidationError.

cancel()

Signs Cancel(bytes32 jobId, uint64 issuedAt) with the owning wallet and posts it for the coordinator to relay to the chain.

  • A client without a signer raises ValidationError before sending.
  • The chain accepts issuedAt within ±600 s of block time. When the handle has seen the coordinator's Date header on an earlier job read, the SDK checks that bound locally and raises ValidationError without sending. A cross-origin browser can read that header only if the coordinator exposes it; otherwise the local check is skipped.
  • A job a provider has already claimed is refused with StateConflictError.

Result types

result() returns a union of classes; narrow it with instanceof:

import { EmbeddingResult, MediaResult, TextResult } from "@vorq-ai/client-sdk";

const result = await handle.result();
if (result instanceof TextResult) console.log(result.text);
else if (result instanceof MediaResult) console.log(result.frames.length, "frames");
else if (result instanceof EmbeddingResult) console.log(result.embeddings.length, "vectors");

All three carry these members:

MemberTypeMeaning
ratesRatesThe order's signed rates, { rateIn: string | null; rateOut: string | null }.
coststringComputed locally as an exact decimal, in atomic token units. See Pricing and payment.
providernumber | string | nullThe registry id of the provider that settled the job.
jobIdstring | nullThe job that produced the result.
customIdstring | nullYour customId, returned from inside the sealed payload.
rawRecord<string, unknown>The opened result object.

TextResult

MemberTypeMeaning
textstringThe generated text, joined from the output items.
outputunknown[]The raw output items (or choices, for a chat-completion-shaped result).
usageRecord<string, unknown>Token usage, as input_tokens, output_tokens, total_tokens.

cost = (input_tokens × rateIn + output_tokens × rateOut) / 1 000 000.

MediaResult

MemberTypeMeaning
framesRecord<string, unknown>[]One per image, or one for a video. Each carries b64, content_type and dimensions.
bytes()Uint8Array[]The frames decoded, in order. No network call.
seednumber | nullThe seed the model used, when reported.

bytes() decodes strictly: a frame with no b64 member, or one that is not valid base64, raises ResultIntegrityError.

cost = delivered pixels (images) or pixel-seconds (video) × rateOut / 1 000 000.

EmbeddingResult

MemberTypeMeaning
embeddingsRecord<string, unknown>[]The response's data array.
modelstring | nullThe model the provider reported.
promptTokensnumberInput tokens billed.
bytes()Uint8Array[]The vectors decoded from base64, in order.

bytes() needs encoding_format: "base64". For float vectors it raises VorqError; read .embeddings directly.

cost = promptTokens × rateIn / 1 000 000.

JobError

A batch line that produced no result. Returned by batch results, never raised.

MemberTypeMeaning
messagestring
typestringprovider_fail, reclaim, cancelled or expired for a line that became a job; the coordinator's refusal code for one that did not; unknown if none was given.
jobIdstring | nullThe correlation key.
customIdstring | nullNormally null: your label is sealed inside the payload, and an error has no sealed result to read it from.
rawRecord<string, unknown>The error object as received.

One result shape everywhere

SourceReturns
handle.result(), client.job(id).result()TextResult / MediaResult / EmbeddingResult; raises JobFailed on failure
batchHandle.results(), batchHandle.consume()the same three, plus JobError for a failed line
sealingFetchthe same job, rendered as an OpenAI Response object

Submit

client.submit — every argument, SLA windows, local validation, unit derivation and reference-asset limits.

Batches

client.batches — submit, get and list, and the BatchHandle a batch is read through.

On this page

JobHandleidtaskCidstatus()result()cancel()Result typesTextResultMediaResultEmbeddingResultJobErrorOne result shape everywhere