Human-in-the-Loop

List Run Questions

Returns pending human-in-the-loop questions for a run. Questions are generated when the workflow needs user input to proceed.

get/api/v1/runs/{id}/questions

Path parameters

idstring required

Unique run identifier (ULID).

Query parameters

page[limit]integer

Maximum number of items to return per page.

page[offset]integer

Number of items to skip before returning results.

Response

Array of pending questions

Example response

{
  "data": [
    {
      "id": "q-001",
      "text": "Should we proceed with the proposed changes?",
      "stage": "gate",
      "allow_freeform": true,
      "timeout_seconds": 30,
      "context_display": "Latest draft",
      "review_target": {
        "label": "Quarry review exercise",
        "url": "https://quarry.lithos.computer/tmp/0123456789abcdef0123456789abcdef"
      }
    }
  ]
}

Changes

Changed in 10 of the 172 revisions of this API.38

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog