Poll a publish task.

Stop polling once status is completed, failed or cancelled.

GEThttps://app.softsolz.uk/api/v1/services/site-builder/tasks/{task_id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

task_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

idstringTask id.

kindstringTask kind.

statusstringreceived, processing, completed, failed or cancelled. Stop polling on a terminal status.

progressobject{ total, processed, failed }.

errorstring | nullFailure reason.

created_atstringEnqueued at.

started_atstring | nullStarted at.

completed_atstring | nullFinished at.

Request

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

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

const result = await client.siteBuilder.getTask('<task_id>');
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "id": "string",
    "kind": "string",
    "status": "string",
    "progress": {},
    "error": "string",
    "created_at": "string",
    "started_at": "string",
    "completed_at": "string"
  }
}