Spaces:
Sleeping
Sleeping
File size: 3,755 Bytes
886d8e9 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
---
title: Computer API
---
The following functions are designed for language models to use in Open Interpreter, currently only supported in [OS Mode](/guides/os-mode/).
### Display - View
Takes a screenshot of the primary display.
```python
interpreter.computer.display.view()
```
### Display - Center
Gets the x, y value of the center of the screen.
```python
x, y = interpreter.computer.display.center()
```
### Keyboard - Hotkey
Performs a hotkey on the computer
```python
interpreter.computer.keboard.hotkey(" ", "command")
```
### Keyboard - Write
Writes the text into the currently focused window.
```python
interpreter.computer.keyboard.write("hello")
```
### Mouse - Click
Clicks on the specified coordinates, or an icon, or text. If text is specified, OCR will be run on the screenshot to find the text coordinates and click on it.
```python
# Click on coordinates
interpreter.computer.mouse.click(x=100, y=100)
# Click on text on the screen
interpreter.computer.mouse.click("Onscreen Text")
# Click on a gear icon
interpreter.computer.mouse.click(icon="gear icon")
```
### Mouse - Move
Moves to the specified coordinates, or an icon, or text. If text is specified, OCR will be run on the screenshot to find the text coordinates and move to it.
```python
# Click on coordinates
interpreter.computer.mouse.move(x=100, y=100)
# Click on text on the screen
interpreter.computer.mouse.move("Onscreen Text")
# Click on a gear icon
interpreter.computer.mouse.move(icon="gear icon")
```
### Mouse - Scroll
Scrolls the mouse a specified number of pixels.
```python
# Scroll Down
interpreter.computer.mouse.scroll(-10)
# Scroll Up
interpreter.computer.mouse.scroll(10)
```
### Clipboard - View
Returns the contents of the clipboard.
```python
interpreter.computer.clipboard.view()
```
### OS - Get Selected Text
Get the selected text on the screen.
```python
interpreter.computer.os.get_selected_text()
```
### Mail - Get
Retrieves the last `number` emails from the inbox, optionally filtering for only unread emails. (Mac only)
```python
interpreter.computer.mail.get(number=10, unread=True)
```
### Mail - Send
Sends an email with the given parameters using the default mail app. (Mac only)
```python
interpreter.computer.mail.send("john@email.com", "Subject", "Body", ["path/to/attachment.pdf", "path/to/attachment2.pdf"])
```
### Mail - Unread Count
Retrieves the count of unread emails in the inbox. (Mac only)
```python
interpreter.computer.mail.unread_count()
```
### SMS - Send
Send a text message using the default SMS app. (Mac only)
```python
interpreter.computer.sms.send("2068675309", "Hello from Open Interpreter!")
```
### Contacts - Get Phone Number
Returns the phone number of a contact name. (Mac only)
```python
interpreter.computer.contacts.get_phone_number("John Doe")
```
### Contacts - Get Email Address
Returns the email of a contact name. (Mac only)
```python
interpreter.computer.contacts.get_phone_number("John Doe")
```
### Calendar - Get Events
Fetches calendar events for the given date or date range from all calendars. (Mac only)
```python
interpreter.computer.calendar.get_events(start_date=datetime, end_date=datetime)
```
### Calendar - Create Event
Creates a new calendar event. Uses first calendar if none is specified (Mac only)
```python
interpreter.computer.calendar.create_event(title="Title", start_date=datetime, end_date=datetime, location="Location", notes="Notes", calendar="Work")
```
### Calendar - Delete Event
Delete a specific calendar event. (Mac only)
```python
interpreter.computer.calendar.delete_event(event_title="Title", start_date=datetime, calendar="Work")
```
|