Generate a branded, hosted QA checklist for any Sloe Labs product.

Generate a branded, hosted QA checklist for any Sloe Labs product. Substrate hosts it at /qa/<id>; non-technical testers run plain-language checks, submit in-page, and the substrate stores results + emits a substrate event (default qa.results.received) so UAT pipelines pick them up automatically.

POSTRequest

curl -X POST https://substrate.sloelabs.com/v1/abilities/qa.checklist.create \
    -H "Authorization: Bearer $SLOE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{"input":{"product":"<product>","tests":[{"title":"<title>","expected_good":"<expected_good>"}]}}'

Responses

200400401403404429501default

Response 200

The ability ran.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "ability": "ability",
  "duration": 0
}

Response 400

The body is missing input, or input fails the ability’s schema (details holds the validation errors).

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 401

No bearer credential, or one the substrate does not recognise.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 403

The credential is valid, but its scope does not include this ability.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 404

No ability has this id.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 429

Too many requests for this credential. retryAfterMs says when to retry.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 501

The ability is declared but no handler is wired.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response default

The ability failed. The message is sanitized; a 5xx may be a transient upstream failure.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Request body

Required

Yes

Content type

• application/json

• inputQaChecklistCreateInputrequired
  Show 6 properties

  • productstringrequired

    Product name shown in the header (e.g. “Sebenza”)

  • phasestringoptional

    Optional phase / release label (e.g. “Phase 08 — Sales & Billing”)

  • contextstringoptional

    Optional one-paragraph context shown above the checks

  • prepared_bystringoptional

    Who prepared the checklist (default: authed tenant or “Sloe Labs”)

  • result_eventstringoptional

    Substrate event name emitted on each submission (default “qa.results.received”)

  • testsobject[]required

    The checks a tester runs, in order

    Show array — 5 properties

    • titlestringrequired

      Short check name

    • stepsstring[]optional

      Plain-language steps the tester performs

    • expected_goodstringrequired

      What a passing result looks like

    • expected_badstringoptional

      What a failing result looks like

    • wherestringoptional

      Where in the product to run this check

• contextCallContextoptional

  Optional call context. The tenant always comes from the credential: tenantId is honoured only by a credential allowed to address sub-tenants, and then nests under the credential’s own tenant.

  Show 3 properties

  • tenantIdstringoptional

    Sub-tenant to act for (sub-tenant credentials only).

  • runIdstringoptional

    The trust run (from trust.preflight) this call executes under.

  • verticalIdstringoptional

    Vertical to attribute created records to.

Returns

Schema shown for 200 · application/json

• result

  The ability’s return value. Its shape depends on the ability.