Revyl YAML Operations API

openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl YAML Operations API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: YAML Operations
paths:
  /api/v1/tests/yaml/from-blocks:
    post:
      description: 'V2 API: Create test from blocks using Phase 1 services


        This endpoint uses the new backend-first architecture:

        - Uses TestCreationService for orchestration

        - Integrates with existing converters

        - Provides clean error handling'
      operationId: create_test_from_blocks_api_v1_tests_yaml_from_blocks_post
      parameters:
      - in: header
        name: X-Revyl-Cloud-Agent-Provider
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Revyl-Cloud-Agent-Provider
      - in: header
        name: X-Revyl-Cloud-Agent-Provider-Conversation-Id
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Revyl-Cloud-Agent-Provider-Conversation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlocksCreationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCreationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Create Test From Blocks
      tags:
      - YAML Operations
components:
  schemas:
    WhileBlock:
      description: Block for loop logic.
      properties:
        children:
          description: Blocks to execute in the loop
          items:
            anyOf:
            - $ref: '#/components/schemas/ActionBlock'
            - $ref: '#/components/schemas/IfBlock'
            - $ref: '#/components/schemas/WhileBlock'
          title: Children
          type: array
        condition:
          anyOf:
          - type: string
          - type: 'null'
          description: Condition to evaluate for loop continuation (alternative to 'step_description')
          title: Condition
        id:
          anyOf:
          - type: string
          - type: 'null'
          description: Unique identifier for the block (auto-generated if not provided)
          title: Id
        step_description:
          anyOf:
          - type: string
          - type: 'null'
          description: Condition to evaluate for loop continuation (alternative to 'condition')
          title: Step Description
        type:
          const: while
          title: Type
          type: string
      required:
      - type
      title: WhileBlock
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ActionBlock:
      description: Block for actions (instructions, extraction, manual, validation, code_execution, module_import).
      properties:
        file:
          anyOf:
          - type: string
          - type: 'null'
          description: Canonical org file name for download_file / play_audio blocks in authored YAML/product payloads
          title: File
        file_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: Resolved revyl-file:// URI for download_file / play_audio blocks
          title: File Uri
        id:
          anyOf:
          - type: string
          - type: 'null'
          description: Unique identifier for the block (auto-generated if not provided)
          title: Id
        module:
          anyOf:
          - type: string
          - type: 'null'
          description: Canonical module name for module_import blocks in authored YAML/product payloads
          title: Module
        module_id:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the module to import (for module_import blocks)
          title: Module Id
        script:
          anyOf:
          - type: string
          - type: 'null'
          description: Canonical script name for code_execution blocks in authored YAML/product payloads
          title: Script
        script_id:
          anyOf:
          - type: string
          - type: 'null'
          description: Resolved script UUID for code_execution blocks
          title: Script Id
        step_description:
          anyOf:
          - type: string
          - type: 'null'
          description: Authored step text or legacy payload. Optional for canonical reference blocks such as code_execution.script, module_import.module, download_file.file, and no-parameter manual steps.
          title: Step Description
        step_type:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/StepType'
          - type: 'null'
          description: Type of step action (inferred when omitted)
          title: Step Type
        type:
          description: 'Must be one of: instructions, extraction, manual, validation, code_execution, module_import'
          enum:
          - instructions
          - extraction
          - manual
          - validation
          - code_execution
          - module_import
          title: Type
          type: string
        variable_name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the variable captured by extraction blocks
          title: Variable Name
        variable_scope:
          anyOf:
          - enum:
            - test
            - global
            type: string
          - type: 'null'
          description: Scope of the variable assigned by extraction or code-execution blocks. 'test' (or omitted) writes to the test-scoped variables table; 'global' writes to a pre-existing, non-secret org-level global variable.
          title: Variable Scope
      required:
      - type
      title: ActionBlock
      type: object
    IfBlock:
      description: Block for conditional logic.
      properties:
        condition:
          anyOf:
          - type: string
          - type: 'null'
          description: Condition to evaluate (alternative to 'step_description')
          title: Condition
        elseChildren:
          description: Blocks to execute if condition is false
          items:
            anyOf:
            - $ref: '#/components/schemas/ActionBlock'
            - $ref: '#/components/schemas/IfBlock'
            - $ref: '#/components/schemas/WhileBlock'
          title: Elsechildren
          type: array
        id:
          anyOf:
          - type: string
          - type: 'null'
          description: Unique identifier for the block (auto-generated if not provided)
          title: Id
        step_description:
          anyOf:
          - type: string
          - type: 'null'
          description: Condition to evaluate (alternative to 'condition')
          title: Step Description
        thenChildren:
          description: Blocks to execute if condition is true
          items:
            anyOf:
            - $ref: '#/components/schemas/ActionBlock'
            - $ref: '#/components/schemas/IfBlock'
            - $ref: '#/components/schemas/WhileBlock'
          title: Thenchildren
          type: array
        type:
          const: if
          title: Type
          type: string
      required:
      - type
      title: IfBlock
      type: object
    TestCreationResponse:
      description: Response model for test creation
      properties:
        blocks_count:
          description: Number of blocks created
          title: Blocks Count
          type: integer
        created_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Creation timestamp
          title: Created At
        errors:
          description: Any errors that occurred
          items:
            type: string
          title: Errors
          type: array
        generated_ids:
          description: List of generated block IDs
          items:
            type: string
          title: Generated Ids
          type: array
        success:
          description: Whether the operation was successful
          title: Success
          type: boolean
        test_id:
          description: Generated test ID
          title: Test Id
          type: string
      required:
      - success
      - test_id
      - blocks_count
      - generated_ids
      title: TestCreationResponse
      type: object
    StepType:
      description: 'User-facing step types for YAML test definitions.


        These are the high-level step types that users write in their tests.

        They map to TASK_TYPES for routing and ActionType for execution.'
      enum:
      - instruction
      - validation
      - extract
      - scrape
      - decision
      - loop
      - explore_continue
      - end
      - wait
      - navigate
      - back
      - open_app
      - kill_app
      - go_home
      - code_execution
      - download_file
      - set_location
      - set_orientation
      - set_appearance
      - play_audio
      - set_font_size
      - module_import
      - tap
      - click
      - double_tap
      - input
      - swipe
      - drag
      - pinch
      - clear_text
      - long_press
      - select
      title: StepType
      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
    BlocksCreationRequest:
      description: Request model for creating tests from blocks
      properties:
        blocks:
          description: List of test blocks
          items:
            anyOf:
            - $ref: '#/components/schemas/ActionBlock'
            - $ref: '#/components/schemas/IfBlock'
            - $ref: '#/components/schemas/WhileBlock'
          title: Blocks
          type: array
        metadata:
          additionalProperties: true
          description: Test metadata
          title: Metadata
          type: object
        options:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Optional creation options
          title: Options
      required:
      - blocks
      - metadata
      title: BlocksCreationRequest
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http