Platform API ClientClient group3 methodsJobsMethods

Jobs

Inspect async proof/replay job state, filter job lists, and trigger retries for eligible failed jobs.

Unified job listJob status lookupRetry support

Jobs

jobs.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/jobs

GET /api/v1/jobs

Signature

list(params?: ListJobsParams): Promise<JobListResponse>

Parameters

Name	Type	Flags
params	ListJobsParams	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as ListJobsParams;
// Fill the params payload fields before calling this method.

const response = await client.jobs.list(params);
console.log(response);

Response

// Response type
Promise<JobListResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

jobs.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/jobs/{jobId}

GET /api/v1/jobs/{jobId}

Signature

get(jobId: string): Promise<JobStatusResponse>

Parameters

Name	Type	Flags
jobId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const jobId = "<jobId>";

const response = await client.jobs.get(jobId);
console.log(response);

Response

// Response type
Promise<JobStatusResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

jobs.retry()

Generated exampleHTTP endpoint wrapperPOST /api/v1/jobs/{jobId}/retry

POST /api/v1/jobs/{jobId}/retry

Signature

retry(jobId: string): Promise<RetryJobResponse>

Parameters

Name	Type	Flags
jobId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const jobId = "<jobId>";

const response = await client.jobs.retry(jobId);
console.log(response);

Response

// Response type
Promise<RetryJobResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));