> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orgo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get VNC password

> Get the VNC password used to connect to the computer.

Returns the computer password for VNC and terminal WebSocket connections.

<Warning>
  This password provides direct access to the computer's display and terminal. Keep it secure and do not share it publicly.
</Warning>

## Path parameters

<ParamField path="id" type="string" required>
  Computer ID.
</ParamField>

## Response

<ResponseField name="password" type="string">
  VNC connection password.
</ResponseField>

## Access control

This endpoint is only accessible to:

* Workspace owners
* Workspace members

Unauthorized users will receive a `403 Forbidden` response.

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl https://www.orgo.ai/api/computers/a3bb189e-8bf9-3888-9912-ace4e6543002/vnc-password \
    -H "Authorization: Bearer $ORGO_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      f"https://www.orgo.ai/api/computers/{computer_id}/vnc-password",
      headers={"Authorization": f"Bearer {api_key}"}
  )

  password = response.json()["password"]
  print(f"VNC Password: {password}")
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(`https://www.orgo.ai/api/computers/${computerId}/vnc-password`, {
    headers: { 'Authorization': `Bearer ${apiKey}` }
  });

  const { password } = await response.json();
  console.log(`VNC Password: ${password}`);
  ```
</CodeGroup>

### Response

```json theme={null}
{
  "password": "0a017c595fa7689753a3"
}
```

## Usage

This password is used for:

1. **VNC connections** - Pass as the password when connecting via any VNC client
2. **Terminal WebSocket** - Pass as the `token` query parameter when connecting to the [Terminal WebSocket](/api-reference/computers/terminal)

<Tip>
  For programmatic control, use the [Computer Actions](/api-reference/computers/click) endpoints instead of VNC. For interactive shell access, use the [Terminal WebSocket](/api-reference/computers/terminal).
</Tip>

## Errors

* `401` - Invalid or missing API key
* `403` - Not a workspace owner or member
* `404` - Computer not found, or password not set


## OpenAPI

````yaml GET /computers/{id}/vnc-password
openapi: 3.1.0
info:
  title: Orgo API
  description: >-
    Launch cloud computers that AI agents can control and interact with. Create
    workspaces, provision computers, and control them programmatically.
  version: 2.0.0
  contact:
    name: Orgo Support
    email: spencer@orgo.ai
    url: https://orgo.ai
servers:
  - url: https://www.orgo.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Organize computers into named workspaces
  - name: Computers
    description: Provision and manage virtual computers
  - name: Computer Lifecycle
    description: Start, stop, and restart computers
  - name: Computer Actions
    description: Control mouse, keyboard, and execute commands
  - name: Streaming
    description: Stream computer display via RTMP
  - name: Files
    description: Upload and download files
  - name: Templates
    description: Author, build, and launch reproducible computers from templates
paths:
  /computers/{id}/vnc-password:
    get:
      tags:
        - Computers
      summary: Get VNC password
      description: >-
        Returns the VNC password for direct VNC connection to the computer. Only
        accessible by workspace owners and members.
      operationId: getVncPassword
      parameters:
        - name: id
          in: path
          required: true
          description: Computer ID
          schema:
            type: string
      responses:
        '200':
          description: VNC password
          content:
            application/json:
              schema:
                type: object
                properties:
                  password:
                    type: string
                    description: VNC connection password
              example:
                password: abc123xyz
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Access denied - not a workspace owner or member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API key
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Resource not found
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your key at orgo.ai/workspaces

````