Client

The public surface is exactly what @vorq-ai/client-sdk exports. Deep imports into dist/ are not supported at any version. Every method that touches the network returns a promise; client.job(id) and client.batches.get(id) build a view from a stored id and make no request.

The client talks to a coordinator and to one storage gateway (for result bytes), and to nothing else: it holds no RPC endpoint or storage credential and builds no transaction.

ConstructorCopy Anchor Link

new Client(options?: ClientOptions)
Client.fromSessionToken(token: string, options?: ClientOptions)

Every option is optional. A client with neither signer nor sessionToken can still make the unauthenticated reads (models, chain and market data).

MembersCopy Anchor Link

SessionsCopy Anchor Link

A client with a signer authenticates by wallet: GET /auth/nonce, a VorqSession EIP-712 signature on the deployment's chain, then POST /auth/session returns a bearer token.

• ensureSession() runs before every request. It mints on first use and re-mints 60 seconds before the token expires; concurrent requests share one mint.
• A 401 re-mints once and re-sends the request, even one that is otherwise never retried.
• Client.fromSessionToken(token) uses the token as-is and never rotates it. Without a signer, a 401 raises AuthenticationError; with one, it re-mints once. submit still needs the signer and cipher.

mintSessionToken({ signer, baseUrl?, fetch? }): Promise<string>

Runs the handshake once and returns the token, for pointing another HTTP client at the coordinator. baseUrl defaults to "https://api.vorq.co".

Retry policyCopy Anchor Link

• A request is retried only when the response carries x-vorq-retryable: true, up to maxRetries times, with backoff 0.5 · 2^attempt + uniform(0, 0.25) seconds.
• Requests that create something are never retried: job submissions, file uploads, batch creation and batch cancel. A job cancel follows the normal policy, since a job cannot be cancelled twice.
• Network failures are never retried. A request that never became a response raises TransportError. (A submission reconciles a dropped connection itself; see Job lifecycle.)
• In a browser, x-vorq-retryable is readable only if the coordinator's CORS policy exposes it.

FilesCopy Anchor Link

client.uploadFile(filename: string, purpose: string, content: Uint8Array | string): Promise<VorqFile>
client.file(fileId: string): Promise<VorqFile>
client.fileContent(fileId: string): Promise<string>

• uploadFile is a multipart POST /v1/files, never retried. purpose is "batch" (a batch input file, sent as application/jsonl), "input" (a sealed container too large to send inline) or "result" (a sealed result), the last two sent as application/octet-stream. submit and batches.submit call it for you.
• file(id) raises NotFoundError both for an unknown id and for another account's file.
• fileContent(id) returns the file body as text.

VorqFile:

Reading result bytesCopy Anchor Link

client.fetchBlob(cid: string): Promise<Uint8Array>

A settled job names its result by content id, and those bytes are read from a storage gateway at {gateway}/ipfs/{cid}, never from the coordinator. The read carries no credentials: the content id is the entitlement. handle.result() and batch results call this for you.

• The gateway resolves in order: the gateway option, then $VORQ_PIN_GATEWAY, then the built-in default. An empty string at either level disables the read path and fetchBlob raises VorqError.
• A network error, 404 or 5xx is retried, up to 8 attempts 1.5 s apart, since a just-settled result may still be propagating. Any other error status raises at once.

const client = Client.fromSessionToken(token, {
  baseUrl: "https://api.vorq.co",
  cipher,                              // needed to open the result
  gateway: "https://ipfs.filebase.io",
});
const result = await client.job(jobId).result(600);

Low-level requestsCopy Anchor Link

client.json<T>(method: string, path: string, options?: RequestOptions): Promise<T>
client.request(method: string, path: string, options?: RequestOptions): Promise<Response>

Any coordinator route, with the session and retry policy applied. A non-2xx response raises the matching error unless its status is in allowStatuses.

RequestOptions:

Environment variablesCopy Anchor Link

Read in Node only; a browser has no environment.