> ## 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.

# Scroll

> Scroll the mouse wheel up or down.

Scrolls the mouse wheel up or down at the cursor's current position (or at `x`, `y` if provided).

## Path parameters

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

## Body parameters

<ParamField body="direction" type="string" default="down">
  Scroll direction: `up` or `down`.
</ParamField>

<ParamField body="amount" type="integer" default="1">
  Number of scroll clicks.
</ParamField>

<ParamField body="x" type="integer">
  Optional X coordinate to move the cursor to before scrolling.
</ParamField>

<ParamField body="y" type="integer">
  Optional Y coordinate to move the cursor to before scrolling.
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  `true` if the scroll was performed.
</ResponseField>

<ResponseField name="action" type="string">
  Always `scroll`.
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  # Scroll down 3 clicks
  curl -X POST https://www.orgo.ai/api/computers/a3bb189e-8bf9-3888-9912-ace4e6543002/scroll \
    -H "Authorization: Bearer $ORGO_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"direction": "down", "amount": 3}'

  # Scroll up 10 clicks
  curl -X POST https://www.orgo.ai/api/computers/a3bb189e-8bf9-3888-9912-ace4e6543002/scroll \
    -H "Authorization: Bearer $ORGO_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"direction": "up", "amount": 10}'
  ```

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

  # Scroll down
  requests.post(
      f"https://www.orgo.ai/api/computers/{computer_id}/scroll",
      headers={"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"},
      json={"direction": "down", "amount": 3}
  )
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://www.orgo.ai/api/computers/${computerId}/scroll`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ direction: 'down', amount: 3 })
  });
  ```
</CodeGroup>

### Response

```json theme={null}
{
  "success": true,
  "action": "scroll",
  "details": { "direction": "down", "amount": 3 }
}
```

## Errors

| Status | Meaning                                  |
| ------ | ---------------------------------------- |
| `400`  | Computer instance not available.         |
| `401`  | Missing or invalid API key.              |
| `403`  | You do not have access to this computer. |
| `404`  | Computer not found.                      |
| `500`  | Upstream desktop agent failure.          |


## OpenAPI

````yaml POST /computers/{id}/scroll
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}/scroll:
    post:
      tags:
        - Computer Actions
      summary: Scroll
      description: Scrolls the mouse wheel up or down.
      operationId: scroll
      parameters:
        - name: id
          in: path
          required: true
          description: Computer ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScrollRequest'
            example:
              direction: down
              amount: 3
      responses:
        '200':
          description: Scroll performed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ScrollRequest:
      type: object
      required:
        - direction
      properties:
        direction:
          type: string
          enum:
            - up
            - down
          description: Scroll direction
        amount:
          type: integer
          default: 3
          description: Scroll amount (clicks)
          minimum: 1
    ActionResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
  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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your key at orgo.ai/workspaces

````