# Workstations

Source: https://opvs.ai/docs/api/workstations

## `GET` /api/v1/workstations

**List Workstations**

List this brand's workstations (newest first).

**Parameters**

- `format` (query, any, optional) — Response format: yaml or md

```bash
curl -X GET 'https://app.opvs.ai/api/v1/workstations' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/workstations",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/workstations", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/workstations

**Order Workstation**

Order a workstation for this brand — the self-serve onboarding entry point.

**Request body**

```bash
curl -X POST 'https://app.opvs.ai/api/v1/workstations' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "runtime": "claude_code",
  "region": "string",
  "description": "string"
}'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/workstations",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string", "runtime": "claude_code", "region": "string", "description": "string"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string", "runtime": "claude_code", "region": "string", "description": "string"})
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string", "runtime": "claude_code", "region": "string", "description": "string"}`)
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/workstations", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `201` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/workstations/{workstation_id}

**Get Workstation**

Fetch one workstation — the onboarding status-poll target for the dashboard.

**Parameters**

- `workstation_id` (path, string, required)
- `format` (query, any, optional) — Response format: yaml or md

```bash
curl -X GET 'https://app.opvs.ai/api/v1/workstations/{workstation_id}' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/workstations/{workstation_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations/{workstation_id}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/workstations/{workstation_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `DELETE` /api/v1/workstations/{workstation_id}

**Decommission Workstation**

Decommission (release) a workstation this brand owns.

**Parameters**

- `workstation_id` (path, string, required)

```bash
curl -X DELETE 'https://app.opvs.ai/api/v1/workstations/{workstation_id}' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.delete(
    "https://app.opvs.ai/api/v1/workstations/{workstation_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations/{workstation_id}", {
  method: "DELETE",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/workstations/{workstation_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/workstations/{workstation_id}/regenerate-pat

**Regenerate Workstation Pat**

Rotate this workstation's install PAT and reveal the new one + installer ONCE.

**Parameters**

- `workstation_id` (path, string, required)

```bash
curl -X POST 'https://app.opvs.ai/api/v1/workstations/{workstation_id}/regenerate-pat' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/workstations/{workstation_id}/regenerate-pat",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations/{workstation_id}/regenerate-pat", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/workstations/{workstation_id}/regenerate-pat", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/workstations/{workstation_id}/install-command

**Reveal Workstation Install Command**

Mint the onboarding command again while no shared-key desk has registered.

**Parameters**

- `workstation_id` (path, string, required)

```bash
curl -X POST 'https://app.opvs.ai/api/v1/workstations/{workstation_id}/install-command' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/workstations/{workstation_id}/install-command",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/workstations/{workstation_id}/install-command", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/workstations/{workstation_id}/install-command", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## List Workstations

`GET https://app.opvs.ai/api/v1/workstations`

List this brand's workstations (newest first).

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Order Workstation

`POST https://app.opvs.ai/api/v1/workstations`

Order a workstation for this brand — the self-serve onboarding entry point.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Get Workstation

`GET https://app.opvs.ai/api/v1/workstations/{workstation_id}`

Fetch one workstation — the onboarding status-poll target for the dashboard.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Decommission Workstation

`DELETE https://app.opvs.ai/api/v1/workstations/{workstation_id}`

Decommission (release) a workstation this brand owns.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Regenerate Workstation Pat

`POST https://app.opvs.ai/api/v1/workstations/{workstation_id}/regenerate-pat`

Rotate this workstation's install PAT and reveal the new one + installer ONCE.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Reveal Workstation Install Command

`POST https://app.opvs.ai/api/v1/workstations/{workstation_id}/install-command`

Mint the onboarding command again while no shared-key desk has registered.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |