Revyl

Revyl Workflow Share API

The Workflow Share API from Revyl — 2 operation(s) for workflow share.

GitHub OpenAPI

Operations 2

POST /api/v1/workflows/share/generate_shareable_link Generate Workflow Shareable Link #
POST /api/v1/workflows/share/unified-report Get Unified Workflow Report #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/openapi/revyl-workflow-share-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-report-context-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-test-resource-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-dashboard-metrics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-test-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-start-device-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-device-session-detail-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/revyl:revyl-workflow-share-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

revyl-workflow-share-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl Workflow Share API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: Workflow Share
paths:
  /api/v1/workflows/share/generate_shareable_link:
    post:
      description: Generate a shareable link for a workflow report.
      operationId: generate_workflow_shareable_link_api_v1_workflows_share_generate_shareable_link_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateWorkflowShareableLinkRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateWorkflowShareableLinkResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Generate Workflow Shareable Link
      tags:
      - Workflow Share
  /api/v1/workflows/share/unified-report:
    post:
      description: Unified endpoint for both public and internal workflow report access.
      operationId: get_unified_workflow_report_api_v1_workflows_share_unified_report_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnifiedWorkflowReportRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnifiedWorkflowReportResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Unified Workflow Report
      tags:
      - Workflow Share
components:
  schemas:
    WorkflowDetailInfo:
      properties:
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        override_run_config:
          default: false
          title: Override Run Config
          type: boolean
        run_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Run Config
        schedule:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule
        schedule_enabled:
          default: false
          title: Schedule Enabled
          type: boolean
        schedule_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Timezone
        tests:
          default: []
          items:
            type: string
          title: Tests
          type: array
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
      required:
      - id
      title: WorkflowDetailInfo
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    TestInfo:
      properties:
        id:
          title: Id
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
      required:
      - id
      title: TestInfo
      type: object
    UnifiedWorkflowReportRequest:
      properties:
        include_video_metadata:
          default: false
          title: Include Video Metadata
          type: boolean
        token:
          anyOf:
          - type: string
          - type: 'null'
          title: Token
        workflow_task_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workflow Task Id
      title: UnifiedWorkflowReportRequest
      type: object
    app__routes__workflow_routes__workflow_share_xpt__StepMetadata:
      properties:
        action_type:
          title: Action Type
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        end_time:
          title: End Time
          type: number
        index:
          title: Index
          type: integer
        start_time:
          title: Start Time
          type: number
      required:
      - index
      - action_type
      - start_time
      - end_time
      title: StepMetadata
      type: object
    WorkflowTaskInfo:
      properties:
        completed_tests:
          anyOf:
          - type: integer
          - type: 'null'
          title: Completed Tests
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        duration:
          anyOf:
          - type: number
          - type: 'null'
          title: Duration
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        task_id:
          title: Task Id
          type: string
        task_ids:
          default: []
          items:
            type: string
          title: Task Ids
          type: array
        total_tests:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Tests
        trace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Trace Id
        triggered_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Triggered By
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
        workflow_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workflow Id
      required:
      - task_id
      title: WorkflowTaskInfo
      type: object
    GenerateWorkflowShareableLinkRequest:
      properties:
        expiration_hours:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expiration Hours
        include_child_tests:
          default: false
          title: Include Child Tests
          type: boolean
        origin:
          anyOf:
          - type: string
          - type: 'null'
          default: https://app.revyl.ai
          title: Origin
        workflow_task_id:
          title: Workflow Task Id
          type: string
      required:
      - workflow_task_id
      title: GenerateWorkflowShareableLinkRequest
      type: object
    GenerateWorkflowShareableLinkResponse:
      properties:
        child_links_created:
          anyOf:
          - type: integer
          - type: 'null'
          title: Child Links Created
        shareable_link:
          title: Shareable Link
          type: string
      required:
      - shareable_link
      title: GenerateWorkflowShareableLinkResponse
      type: object
    VideoMetadataInfo:
      properties:
        duration:
          title: Duration
          type: number
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        steps:
          default: []
          items:
            $ref: '#/components/schemas/app__routes__workflow_routes__workflow_share_xpt__StepMetadata'
          title: Steps
          type: array
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        task_id:
          title: Task Id
          type: string
        test_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Test Name
        video_duration:
          anyOf:
          - type: number
          - type: 'null'
          title: Video Duration
        video_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Video Url
      required:
      - task_id
      - duration
      title: VideoMetadataInfo
      type: object
    UnifiedWorkflowReportResponse:
      properties:
        child_share_status:
          additionalProperties:
            additionalProperties: true
            type: object
          default: {}
          title: Child Share Status
          type: object
        child_tasks:
          default: []
          items:
            $ref: '#/components/schemas/ChildTaskReportInfo'
          title: Child Tasks
          type: array
        is_public_view:
          default: false
          title: Is Public View
          type: boolean
        test_info:
          default: []
          items:
            $ref: '#/components/schemas/TestInfo'
          title: Test Info
          type: array
        video_metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/VideoMetadataInfo'
            type: object
          - type: 'null'
          title: Video Metadata
        workflow_detail:
          anyOf:
          - $ref: '#/components/schemas/WorkflowDetailInfo'
          - type: 'null'
        workflow_task:
          $ref: '#/components/schemas/WorkflowTaskInfo'
      required:
      - workflow_task
      title: UnifiedWorkflowReportResponse
      type: object
    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
    ChildTaskReportInfo:
      properties:
        app_id:
          anyOf:
          - type: string
          - type: 'null'
          title: App Id
        branch_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Branch Id
        branch_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Branch Name
        build_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Build Id
        build_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Build Version
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
        current_step:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Step
        duration:
          anyOf:
          - type: number
          - type: 'null'
          title: Duration
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
        execution_time_seconds:
          anyOf:
          - type: number
          - type: 'null'
          title: Execution Time Seconds
        is_shared:
          default: false
          title: Is Shared
          type: boolean
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        progress:
          anyOf:
          - type: number
          - type: 'null'
          title: Progress
        share_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Share Token
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        steps_completed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Steps Completed
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        task_id:
          title: Task Id
          type: string
        test_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Test Id
        test_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Test Name
        total_steps:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Steps
      required:
      - task_id
      title: ChildTaskReportInfo
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http