Add guidance to a browser workflow recording
Adds written guidance and structured notes to a finalized browser workflow recording.
OpenAPI
````yaml post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/{domainKey}/{recordingId}/commentary
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/{domainKey}/{recordingId}/commentary:
post:
tags:
- Computer Agents
summary: Add guidance to a browser workflow recording
description: >-
Adds written guidance and structured notes to a finalized browser
workflow recording.
operationId: workflowRecordingsPostRecordCommentary
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
- name: domainKey
in: path
required: true
description: ''
schema: {}
- name: recordingId
in: path
required: true
description: ''
schema: {}
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
- notes
properties:
text:
type: string
description: Overall workflow intent, constraints, and expected outcome.
notes:
type: array
description: Guidance tied to exact moments in the recording timeline.
items:
type: object
required:
- t
- text
properties:
id:
type: string
description: Existing note identifier when updating a note.
t:
type: integer
minimum: 0
description: Milliseconds from the beginning of the recording.
text:
type: string
description: Guidance for what happens at this moment.
responses:
'200':
description: Successful response
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
