Get Computer Agent Canvas access

Returns the selected Computer Agent's current Canvas availability, visibility, workspace paths, and a ready-to-open URL when access is available. A public Canvas includes a stable publicUrl. A private Canvas includes only a short-lived launchRef. Visibility is read-only through this API.

OpenAPI

````yaml get /api/v2/computer/accounts/{targetAccountId}/canvas
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}/canvas:
get:
tags:
- Computer Agents
summary: Get Computer Agent Canvas access
description: >
Returns the selected Computer Agent's current Canvas availability,
visibility, workspace paths, and a ready-to-open URL when access is
available. A public Canvas includes a stable publicUrl. A private Canvas
includes only a short-lived launchRef. Visibility is read-only through
this API.
operationId: canvasGetCanvas
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: Canvas access details
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
available:
type: boolean
visibility:
type: string
enum:
- public
- private
- 'off'
sourcePath:
type: string
enum:
- app
description: Workspace directory containing editable Canvas source.
publishedPath:
type: string
enum:
- public
description: >-
Protected workspace directory containing generated Canvas
files.
publicUrl:
type: string
format: uri
nullable: true
description: >-
Stable share URL when visibility is public; otherwise
null.
launchRef:
type: object
nullable: true
required:
- method
- href
- expiresAtMs
properties:
method:
type: string
enum:
- GET
href:
type: string
format: uri
description: Complete URL for opening the Canvas.
expiresAtMs:
type: integer
format: int64
nullable: true
description: >-
Expiration time for private access, or null for a
public URL.
required:
- available
- visibility
- sourcePath
- publishedPath
- publicUrl
- launchRef
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token

````