Revyl Workflow Status API

openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl Workflow Status API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: Workflow Status
paths:
  /api/v1/workflows/status/history/{workflow_id}:
    get:
      description: Get execution history with org-based authorization.
      operationId: get_workflow_execution_history_api_v1_workflows_status_history__workflow_id__get
      parameters:
      - in: path
        name: workflow_id
        required: true
        schema:
          title: Workflow Id
          type: string
      - in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          title: Limit
          type: integer
      - in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          title: Offset
          type: integer
      - description: Start date in ISO format (YYYY-MM-DD) - get executions from this date to now
        in: query
        name: start_date
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Start date in ISO format (YYYY-MM-DD) - get executions from this date to now
          title: Start Date
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowExecutionHistoryResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Get Workflow Execution History
      tags:
      - Workflow Status
  /api/v1/workflows/status/{task_id}:
    get:
      description: Get real-time status of a specific workflow execution.
      operationId: get_workflow_status_api_v1_workflows_status__task_id__get
      parameters:
      - in: path
        name: task_id
        required: true
        schema:
          title: Task Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStatusResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Get Workflow Status
      tags:
      - Workflow Status
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    WorkflowExecutionHistoryResponse:
      description: Response model for workflow execution history.
      properties:
        average_duration:
          anyOf:
          - type: number
          - type: 'null'
          title: Average Duration
        executions:
          items:
            $ref: '#/components/schemas/WorkflowStatusResponse'
          title: Executions
          type: array
        success_rate:
          title: Success Rate
          type: number
        total_count:
          title: Total Count
          type: integer
        workflow_id:
          format: uuid
          title: Workflow Id
          type: string
      required:
      - workflow_id
      - executions
      - total_count
      - success_rate
      title: WorkflowExecutionHistoryResponse
      type: object
    WorkflowStatusResponse:
      description: Response model for workflow status polling that matches frontend expectations.
      properties:
        completed_tests:
          title: Completed Tests
          type: integer
        duration:
          anyOf:
          - type: string
          - type: 'null'
          title: Duration
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
        estimated_completion:
          anyOf:
          - type: string
          - type: 'null'
          title: Estimated Completion
        execution_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Execution Id
        failed_tests:
          default: 0
          title: Failed Tests
          type: integer
        metadata:
          additionalProperties: true
          default: {}
          title: Metadata
          type: object
        passed_tests:
          default: 0
          title: Passed Tests
          type: integer
        progress:
          title: Progress
          type: number
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
        status:
          $ref: '#/components/schemas/WorkflowStatus'
        total_tests:
          title: Total Tests
          type: integer
        workflow_id:
          format: uuid
          title: Workflow Id
          type: string
      required:
      - workflow_id
      - status
      - progress
      - completed_tests
      - total_tests
      title: WorkflowStatusResponse
      type: object
    WorkflowStatus:
      description: Workflow execution status.
      enum:
      - queued
      - setup
      - running
      - completed
      - failed
      - cancelled
      - timeout
      title: WorkflowStatus
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http