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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # ListJobsParams

response = platform.jobs.list(params)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

jobId = "<jobId>"

response = platform.jobs.get(jobId)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

jobId = "<jobId>"

response = platform.jobs.retry(jobId)
print(response)

Response

// Response type
Promise<RetryJobResponse>

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