Get browser workflow status
Shows recording and browser-helper generation status. Active generation includes a conversation reference that explains how to open its live GetVoiceBot chat.
OpenAPI
````yaml get /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/status
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/computer/accounts/{targetAccountId}/workflow-recordings/status:
get:
tags:
- Computer Agents
summary: Get browser workflow status
description: >
Shows recording and browser-helper generation status. Active generation
includes a conversation reference that explains how to open its live
GetVoiceBot chat.
operationId: workflowRecordingsGetStatus
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: Current recording and generation status
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
recording:
type: object
nullable: true
additionalProperties: true
properties:
state:
type: string
description: Current recorder lifecycle state.
active:
type: boolean
recordingId:
type: string
nullable: true
description: Stable identifier allocated when recording starts.
slotId:
type: integer
nullable: true
finalized:
type: boolean
description: >-
True only after recording analysis and artifact
finalization succeed.
analysisStatus:
type: string
nullable: true
fileSizeBytes:
type: integer
nullable: true
artifacts:
type: array
items:
type: string
updatedAt:
type: string
format: date-time
evidenceRoot:
type: string
description: >-
Workspace-relative directory containing the selected
recording evidence.
generation:
type: object
nullable: true
additionalProperties: true
properties:
state:
type: string
phase:
type: string
description: >-
Current generation phase, such as starting, running,
reviewing, recovering, completed, or failed.
generationId:
type: string
recordingIds:
type: array
description: >-
Immutable recording snapshot selected when this
generation started.
items:
type: string
updatedAt:
type: string
format: date-time
lastActivityAt:
type: string
format: date-time
description: Last worker heartbeat, output, or phase transition.
evidenceRoot:
type: string
description: >-
Workspace-relative directory containing the selected
recording evidence.
sessionKey:
type: string
conversationRef:
type: object
properties:
sessionKey:
type: string
resolve:
type: object
additionalProperties: true
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
