Jobs API

The Jobs API is a secure REST API that manage jobs.

Request authorization

To authenticate your requests, you must use a Bearer token with a valid Solver API key.

For example:

Authorization: Bearer YOUR_SOLVER_API_KEY

Start a new job.

post

Starts a new asynchronous job for a specific Integration Flow. The identifier is the unique ID of the Integration Flow, and version is its specific version. This endpoint only accepts rules of type IntegrationFlow.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

identifierstringRequired

The unique identifier of the Integration Flow.

versionstringOptional

The specific version of the Integration Flow. If not provided, the latest published version is used.

Body

application/json

A JSON object containing the input data for the job.

Other propertiesanyOptional

Responses

200

Job started successfully.

application/json

400

Business error.

401

Unauthorized. Invalid or missing API key.

post

/start/{identifier}/{version}

HTTPcURLJavaScriptPython

POST /job/start/{identifier}/{version} HTTP/1.1
Host: api.decisionrules.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "jobId": "text",
  "status": {
    "state": "WAITING",
    "code": "JOB_SUCCESS",
    "message": "text"
  }
}

Cancel a job.

post

Attempts to cancel a specific job by its ID. The job must belong to the requesting space.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdstringRequired

The ID of the job to cancel.

Responses

200

Job canceled successfully.

application/json

400

Business error.

401

Unauthorized. Invalid or missing API key.

post

/cancel/{jobId}

HTTPcURLJavaScriptPython

POST /job/cancel/{jobId} HTTP/1.1
Host: api.decisionrules.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "jobId": "text",
  "correlationId": "text",
  "inputData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "output": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ruleReference": {
    "baseId": "text",
    "version": 1,
    "type": "text"
  },
  "context": {
    "spaceId": "text",
    "billingUserId": "text",
    "executorUser": {},
    "usedApiKeyId": "text"
  },
  "status": {
    "state": "WAITING",
    "code": "JOB_SUCCESS",
    "message": "text"
  },
  "createdAt": "2026-02-02T14:18:31.050Z",
  "updatedAt": "2026-02-02T14:18:31.050Z",
  "claimedAt": "2026-02-02T14:18:31.050Z",
  "endedAt": "2026-02-02T14:18:31.050Z",
  "apiKey": {
    "id": "text",
    "name": "text"
  }
}

Cancel all waiting jobs for a space.

post

Cancels all jobs that are in a WAITING state for a specific space.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The ID of the space.

Responses

200

The number of waiting jobs that were canceled.

application/json

400

Business error.

401

Unauthorized. Invalid or missing API key.

post

/cancelAll/space/{spaceId}

HTTPcURLJavaScriptPython

POST /job/cancelAll/space/{spaceId} HTTP/1.1
Host: api.decisionrules.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "canceledCount": 1
}

Cancel all waiting jobs for a rule.

post

Cancels all jobs that are in a WAITING state for a specific rule identifier and an optional version.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

identifierstringRequired

The identifier of the rule.

versionstringOptional

The version of the rule. If not provided, jobs for all versions of the rule will be considered.

Responses

200

The number of waiting jobs that were canceled for the rule.

application/json

400

Bad request. Rule identifier or version is invalid.

401

Unauthorized. Invalid or missing API key.

403

Forbidden. Insufficient permissions to cancel jobs for this rule.

post

/cancelAll/rule/{identifier}/{version}

HTTPcURLJavaScriptPython

POST /job/cancelAll/rule/{identifier}/{version} HTTP/1.1
Host: api.decisionrules.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "canceledCount": 1
}

Get job details.

get

Retrieves detailed information about a specific job, including its status and output. The job must belong to the requesting space.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdstringRequired

The ID of the job to retrieve details for.

Responses

200

Job details retrieved successfully.

application/json

400

Business error.

401

Unauthorized. Invalid or missing API key.

get

/{jobId}

HTTPcURLJavaScriptPython

GET /job/{jobId} HTTP/1.1
Host: api.decisionrules.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "jobId": "text",
  "correlationId": "text",
  "inputData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "output": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ruleReference": {
    "baseId": "text",
    "version": 1,
    "type": "text"
  },
  "context": {
    "spaceId": "text",
    "billingUserId": "text",
    "executorUser": {},
    "usedApiKeyId": "text"
  },
  "status": {
    "state": "WAITING",
    "code": "JOB_SUCCESS",
    "message": "text"
  },
  "createdAt": "2026-02-02T14:18:31.050Z",
  "updatedAt": "2026-02-02T14:18:31.050Z",
  "claimedAt": "2026-02-02T14:18:31.050Z",
  "endedAt": "2026-02-02T14:18:31.050Z",
  "apiKey": {
    "id": "text",
    "name": "text"
  }
}