Cancel a queued or running research run.

Stop a SoftSolz research run. A queued run ends immediately; a running run stops after the company it is on and keeps the leads already saved. Answers 409 run_not_cancellable once the run has finished.

POSThttps://app.softsolz.uk/api/v1/services/my-leads/runs/{id}/cancel

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

idintegerRun id.

titlestringWhat was researched.

modestringdocument is a written report; leads and businesses produce lead records.

statusstringRun lifecycle.

total_countintegerCompanies found to research.

processed_countintegerCompanies researched so far.

credits_usednumberSoftSolz AI credits the run spent.

cancel_requested_atstring | nullSet once a cancel was requested.

error_messagestring | nullWhy the run failed, if it did.

created_atstringWhen it started.

updated_atstringLast progress update.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.myLeads.cancelRun('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "title": "string",
    "mode": "string",
    "status": "string",
    "total_count": 0,
    "processed_count": 0,
    "credits_used": 0,
    "cancel_requested_at": "string",
    "error_message": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}