List SoftSolz research runs.

List research runs that SoftSolz itself performed from the dashboard (these spend SoftSolz AI credits; the API cannot start one). Use it to see what has already been researched before you research it yourself.

GEThttps://app.softsolz.uk/api/v1/services/my-leads/runs

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

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

Query Params

statusstring

Filter by status (queued|running|completed|failed|cancelled).

modestring

document, leads or businesses.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Rows to skip.

Response

Response Body · array of objects

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.listRuns({});
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"
    }
  ]
}