Skip to main content

TaskList

Paginated task list response for GET /tasks.

Pagination is cursor-based. next_cursor is the task_id of the last item in the current page — pass it as ?cursor= on the next request. next_cursor is None when has_more is False.

items object[]required
  • Array [
    • task_id object
    anyOf
    string
    intentIntent (string)required
    concept_idConcept Id (string)required
    concept_versionConcept Version (string)required
    condition_idCondition Id (string)required
    condition_versionCondition Version (string)required
    action_idAction Id (string)required
    action_versionAction Version (string)required
    entity_scopeEntity Scope (string)required
    delivery objectrequired

    Describes how a triggered condition delivers its alert.

    Validation rules (enforced at model construction time): webhook → endpoint is required notification → channel is required email → channel is required workflow → workflow_id is required

    typeDeliveryType (string)required

    Possible values: [webhook, notification, email, workflow]

    endpoint object
    anyOf
    string
    channel object
    anyOf
    string
    workflow_id object
    anyOf
    string
    statusTaskStatus (string)

    Full set of task statuses.

    active — evaluated by the application on its own schedule. paused — skipped; no evaluation or alerts until resumed. deleted — soft-deleted; retained for audit, no evaluation. Irreversible via API. preview — dry_run result only; MUST NEVER be persisted to the DB.

    Possible values: [active, paused, deleted, preview]

    Default value: active
    created_at object
    anyOf
    string<date-time>
    last_triggered_at object
    anyOf
    string<date-time>
    context_version object
    anyOf
    string
    context_warning object
    anyOf
    string
    guardrails_version object
    anyOf
    string
  • ]
    • has_moreHas More (boolean)required
    next_cursor object
    anyOf
    string
    total_countTotal Count (integer)required
    TaskList
    {
      "items": [
        {
          "task_id": "string",
          "intent": "string",
          "concept_id": "string",
          "concept_version": "string",
          "condition_id": "string",
          "condition_version": "string",
          "action_id": "string",
          "action_version": "string",
          "entity_scope": "string",
          "delivery": {
            "type": "webhook",
            "endpoint": "string",
            "channel": "string",
            "workflow_id": "string"
          },
          "status": "active",
          "created_at": "2024-07-29T15:51:28.071Z",
          "last_triggered_at": "2024-07-29T15:51:28.071Z",
          "context_version": "string",
          "context_warning": "string",
          "guardrails_version": "string"
        }
      ],
      "has_more": true,
      "next_cursor": "string",
      "total_count": 0
    }