> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sagescreen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get overall workflow status

> Returns the overall workflow run status (e.g. `completed`,
`running`, `failed`). Called when `get_step_status` indicates
no current step, to determine if the entire workflow is done.

Registered as `wp_ajax_sagescreen_get_workflow_status` — **login required**.




## OpenAPI

````yaml /openapi/private/specs/wp/sage-internal.yml post /wp-admin/admin-ajax.php?action=sagescreen_get_workflow_status
openapi: 3.1.0
info:
  title: SageScreen — Sage Module
  description: >
    Council sage management. Sages are AI screening assistants customized

    per council. Each council can have system sages (non-customizable,

    auto-attached) and custom sages (built through a multi-step workflow).


    **CPT:** `ss_council_sage`

    **Custom statuses:** `ss_draft`, `ss_building`, `ss_active`, `ss_inactive`,
    `ss_paused`


    ## Build Workflow


    Custom sages go through a 6-step creation workflow:

    1. **Context** — Define role, level, and job description

    2. **Culture** — Configure tone, scoring, intro question, evaluation
    guidelines

    3. **Build** — Automated build via Python service (8 sub-steps)

    4. **Test** — Optional test screen to verify sage behavior

    5. **Finalize** — Review and confirm build

    6. **Deploy** — Set email config and activate sage


    Build sub-steps (step 3) run sequentially in the Python service:

    `starting` → `creating_sage` → `sage_generation` → `test_shu` →

    `test_ha` → `test_ri` → `transcending_training` → `enlightenment`
  version: 1.0.0
servers:
  - url: https://{domain}/wp-json/sagescreen/v1
    description: WordPress REST API
    variables:
      domain:
        default: api.sagescreen.app
security: []
tags:
  - name: Sage – REST
    description: REST API endpoints for sage operations and Python callbacks
  - name: Sage – CRUD
    description: AJAX endpoints for sage creation, editing, and status management
  - name: Sage – Build Workflow
    description: AJAX endpoints for the multi-step sage build process
paths:
  /wp-admin/admin-ajax.php?action=sagescreen_get_workflow_status:
    post:
      tags:
        - Sage – Build Workflow
      summary: Get overall workflow status
      description: >
        Returns the overall workflow run status (e.g. `completed`,

        `running`, `failed`). Called when `get_step_status` indicates

        no current step, to determine if the entire workflow is done.


        Registered as `wp_ajax_sagescreen_get_workflow_status` — **login
        required**.
      operationId: ajaxGetWorkflowStatus
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - action
                - nonce
                - run_id
              properties:
                action:
                  type: string
                  const: sagescreen_get_workflow_status
                nonce:
                  type: string
                  description: WP nonce for `sagescreen_frontend_nonce`
                  examples:
                    - abc123def456
                run_id:
                  type: string
                  description: Workflow run ID
                  examples:
                    - run_abc123def456
      responses:
        '200':
          description: Workflow status
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/WorkflowStatusSuccess'
                  - $ref: '#/components/schemas/AjaxErrorResponse'
              examples:
                completed:
                  summary: Workflow completed
                  value:
                    success: true
                    state: completed
                running:
                  summary: Workflow still running
                  value:
                    success: true
                    state: running
                failed:
                  summary: Workflow failed
                  value:
                    success: true
                    state: failed
      security:
        - wpAjaxNonce: []
components:
  schemas:
    WorkflowStatusSuccess:
      type: object
      properties:
        success:
          type: boolean
          const: true
          examples:
            - true
        state:
          type: string
          description: Overall workflow state
          enum:
            - running
            - active
            - in_progress
            - completed
            - failed
            - error
          examples:
            - completed
    AjaxErrorResponse:
      type: object
      description: |
        Standard AJAX error. The `data` field is either a plain string
        (from `wp_send_json_error`) or absent when using `wp_send_json`
        directly with `success: false`.
      properties:
        success:
          type: boolean
          const: false
          examples:
            - false
        message:
          type: string
          description: Error message (when using wp_send_json directly)
          examples:
            - Security check failed
        data:
          oneOf:
            - type: string
              examples:
                - Security check failed
            - type: object
              properties:
                message:
                  type: string
                  examples:
                    - Insufficient permissions
  securitySchemes:
    wpAjaxNonce:
      type: apiKey
      in: query
      name: nonce
      description: WordPress AJAX nonce (passed as form field, verified per-action)

````